v1

latestOpenAPI 3.0.3MIT2026-07-24122271451.2 KB

Webhook subscriptions

Create Webhook Subscription

This operation creates a new webhook subscription by specifying its details.

post/public/v1/webhook-subscriptions

Request body

namestring required

Set a name for the Webhooks subscription.

urlstring url required

Set the Webhooks subscription URL.

activeboolean

Set the status of the Webhooks subscription.

payloadWebhookSubscriptionPayloadEnum[] nullable

Set a payload structure.

triggersWebhookSubscriptionTriggerEnum[] nullable required

Set trigger events for the Webhooks subscription.

Example request

{
  "name": "My Subscription",
  "url": "https://example.com",
  "payload": [
    "pricing"
  ],
  "triggers": [
    "document_state_changed"
  ]
}

Response

Webhook subscription created

uuidstring uuid nullable

namestring

urlstring url

activeboolean

payloadWebhookSubscriptionPayloadEnum[] nullable

triggersWebhookSubscriptionTriggerEnum[] nullable

workspace_idstring

shared_keystring

status'ACTIVE' | 'INACTIVE' | 'DEACTIVATED'

Example response

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "name": "My Subscription",
  "url": "https://example.com",
  "active": true,
  "payload": [
    "pricing"
  ],
  "triggers": [
    "document_state_changed"
  ],
  "workspace_id": "Nq8htXxFssmhRxAPSP4SBP",
  "shared_key": "587c22285F57883db3ee",
  "status": "ACTIVE"
}