ioZen Docs
API ReferenceWebhooks
POST
/webhooks

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Request Body

Webhook URL, events, optional description, and optional intake_bot_ids

application/json
  1. body
url*string

HTTPS URL to receive webhook payloads

Formaturi
Lengthlength <= 2048
events*array<v1WebhookEventSchema>

Event types to subscribe to (e.g. submission.completed)

Items1 <= items
description?string

Human-readable description for this endpoint

Lengthlength <= 500
intake_bot_ids?array<>

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

Itemsitems <= 50

Response Body

Webhook endpoint created with signing secret

application/json
  1. response
webhook*
curl -X POST 'https://app.iozen.ai/api/v1/webhooks' \  -H 'Content-Type: application/json' \  -d '{  "url": "https://api.example.com/webhooks/iozen",  "events": [    "submission.completed"  ],  "description": "Production submission handler",  "intake_bot_ids": []}'
Example Response
{  "webhook": {    "id": "string",    "url": "string",    "events": [      "string"    ],    "status": "string",    "description": "string",    "intake_bot_ids": [      "string"    ],    "last_delivery_at": "string",    "last_delivery_ok": true,    "consecutive_fails": 0,    "created_at": "string",    "updated_at": "string",    "secret": "string"  }}

Get webhook endpoint GET

Retrieves a single webhook endpoint by ID.

Update webhook endpoint PATCH

Partially updates a webhook endpoint. URL cannot be changed (the signing secret is bound to it). Allowed fields: events, description, status (active|paused), intake_bot_ids.