ioZen Docs
API ReferenceWebhooks
PATCH
/webhooks/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Webhook endpoint ID

Request Body

application/json

Fields to update

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://app.iozen.ai/api/v1/webhooks/cm7abc12x0001yz9k8mno3pqr" \  -H "Content-Type: application/json" \  -d '{    "status": "paused"  }'
{
  "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"
    }
  }
}
{
  "success": false,
  "error": {
    "code": "validation_failed",
    "message": "Validation failed",
    "details": {}
  }
}
{
  "success": false,
  "error": {
    "code": "authentication_required",
    "message": "Missing or invalid API key",
    "details": {}
  }
}
{
  "success": false,
  "error": {
    "code": "insufficient_scopes",
    "message": "API key lacks required scopes for this endpoint",
    "details": {}
  }
}
{
  "success": false,
  "error": {
    "code": "resource_not_found",
    "message": "Resource not found",
    "details": {}
  }
}
{
  "success": false,
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Rate limit exceeded",
    "details": {}
  }
}
{
  "success": false,
  "error": {
    "code": "internal_error",
    "message": "An internal error occurred",
    "details": {}
  }
}

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.