Document AI — Webhooks

Update Webhook Subscription

po_webhooks_update: Update an existing webhook subscription. Can change name, URL, events, secret, filters, headers, retry policy, active status, and timeouts. Keywords: update webhook, modify subscription, change webhook. Accepts...

post/webhooks/update

Request

  • Base URL: https://api.paperoffice.ai/latest
  • URL: https://api.paperoffice.ai/latest/webhooks/update
  • Auth: HTTP bearer

Request body

subscription_idinteger required

ID of the Subscription (Required)

namestring

New subscription name.

urlstring

New webhook URL.

eventsstring[]

New event list.

secretstring

New signing secret.

filtersobject

new Filter

headersobject

New custom headers.

is_activeboolean

Set subscription active (true) or inactive (false). Reactivation resets the auto-disable failure counter. Accepts true/false, 1/0, yes/no, on/off (JSON boolean or form string); other values return 400 INVALID_BOOLEAN.

retry_policy'none' | 'linear' | 'exponential'

Retry policy: none, linear, or exponential (default: exponential).

max_retriesinteger

New maximum retry count.

timeout_msinteger

New timeout in milliseconds.

Response

Success

status'success' required
_billingobject

Changes

No recorded changes to this operation across all 1 revision of this API.