ioZen Docs
API ReferenceWebhooks
PATCH
/webhooks/{id}

Authorization

bearerAuth
headerAuthorizationBearer <token>

API key authentication. Pass your ioZen API key as a Bearer token in the Authorization header.

Path Parameters

id*string

Webhook endpoint ID

Request Body

Fields to update

application/json
  1. body
events?array<v1WebhookEventSchema>

Event types to subscribe to

Items1 <= items
description?string

Human-readable description for this endpoint

Lengthlength <= 500
status?string

Endpoint status. url cannot be changed (secret is bound to it).

Value in"active""paused"
intake_bot_ids?array<>

Restrict deliveries to these intake bots. Omit or pass [] for all bots in the workspace.

Itemsitems <= 50

Response Body

Successful response

application/json
  1. response
success*true
Value intrue
data*
curl -X PATCH 'https://app.iozen.ai/api/v1/webhooks/cm7abc12x0001yz9k8mno3pqr' \  -H 'Content-Type: application/json' \  -d '{  "status": "paused"}'
Example Response
{  "success": true,  "data": {    "webhook": {      "id": "cm7wh01a0001yz9k8mno3pqr",      "url": "https://api.example.com/webhooks/iozen",      "events": [        "submission.completed",        "contact.created"      ],      "status": "paused",      "description": "Paused while the receiver is upgraded",      "intake_bot_ids": [        "cm7abc12x0001yz9k8mno3pqr"      ],      "last_delivery_at": "2026-02-24T16:30:00.000Z",      "last_delivery_ok": true,      "consecutive_fails": 0,      "created_at": "2026-02-01T09:00:00.000Z",      "updated_at": "2026-02-24T17:00:00.000Z"    }  }}

Create webhook endpoint POST

Registers a new webhook endpoint. The secret for signature verification is returned once in the response — store it securely. Optionally restrict deliveries with `intake_bot_ids` (empty/omitted = all bots).

Delete webhook endpoint DELETE

Permanently deletes a webhook endpoint. No further events will be delivered to it.