PApandadoc
Webhook subscriptions

Update Webhook Subscription

Changed on

This operation updates the details of a webhook subscription.

patch/public/v1/webhook-subscriptions/{id}

Request

Path parameters

idstring uuid required

Webhook subscription uuid

Request body

namestring

Set a new name for the Webhooks subscription.

urlstring url

Set the new Webhooks subscription URL.

activeboolean

Set the status of the Webhooks subscription.

payloadWebhookSubscriptionPayloadEnum[] nullable

Set a new payload structure.

triggersWebhookSubscriptionTriggerEnum[] nullable

Set trigger events for the Webhooks subscription.

Example request

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

Response

Webhook subscription updated

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"
}

Changes

  • b9a306b1a421Revision changes
    • warning

      added the new recipient_qes_verified enum value to the / response property for the response status

    • info

      added the new recipient_qes_verified enum value to the request property /