PAparsewise
Webhooks

Update a webhook subscription

Manage outbound webhook subscriptions for the authenticated tenant.

Subscriptions are tenant-scoped. Only active subscriptions are returned by list and retrieve. Deletion is permanent — the row is removed from the DB and any associated delivery rows cascade.

patch/webhooks/{id}/

Request

  • Base URL
    https://api.parsewise.ai/api/v1
  • Auth
    API key in header X-API-Key

Path parameters

idstring uuid required

Request body

namestring

Friendly name for this subscription (optional).

urlstring

HTTPS URL Parsewise will POST webhook events to.

subscribed_eventsstring[]

Event names this subscription should receive.

headersobject

Custom HTTP headers to include with every delivery. Encrypted at rest. Up to 10 entries; values up to 1KB each; total ≤ 4KB. The Host, Connection, Content-Length, Transfer-Encoding, Content-Type and any Parsewise-* headers are reserved.

Response

idstring uuid required
namestring required
urlstring required
subscribed_eventsstring[] required

Event names this subscription is subscribed to.

is_activeboolean required
headersobject required

Custom request header keys registered for this subscription. Values are always redacted.

created_atstring date-time required
updated_atstring date-time required

Changes

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