Sign in
Webhook Subscriptions

Update a webhook subscription

Updates the destination, event types, or active state.

patch/webhooks/{webhookId}

Request

  • Base URL: https://next-api.saturation.io/v1
  • URL: https://next-api.saturation.io/v1/webhooks/{webhookId}
  • Auth: HTTP bearer

Path parameters

webhookIdstring required

A stable resource ID, such as prj_…, txn_…, or doc_….

Example:txn_8f2a1c9e

Webhook subscription identifier (whk_…).

Request body

urlstring uri

New HTTPS destination. The host must resolve to a public address.

eventsWebhookEvent[]

Replacement event set.

isActiveboolean

Pause (false) or resume (true) deliveries.

Example request

{
  "url": "https://hooks.example.com/saturation/v2",
  "events": [
    "transaction.created"
  ]
}

Response

The updated webhook subscription.

idstring required

A stable resource ID, such as prj_…, txn_…, or doc_….

urlstring uri required

HTTPS destination for deliveries. The host must resolve to a public address.

eventsWebhookEvent[] required

Event types delivered to this endpoint.

isActiveboolean required

Whether the subscription currently receives deliveries. Toggled via PATCH; a webhook continues to exist while paused.

workspaceIdstring required

A stable resource ID, such as prj_…, txn_…, or doc_….

projectIdstring

A stable resource ID, such as prj_…, txn_…, or doc_….

lastDeliveryAtstring date-time

Time of the most recent delivery attempt.

lastDeliveryStatus'pending' | 'success' | 'failed' | 'blocked' | 'dropped'

Outcome of a delivery. pending may be retried. success, failed, blocked, and dropped are final.

createdAtstring date-time required

ISO-8601 creation timestamp.

updatedAtstring date-time required

ISO-8601 last-update timestamp.

Example response

{
  "id": "txn_8f2a1c9e",
  "url": "https://hooks.example.com/saturation",
  "events": [
    "transaction.created"
  ],
  "workspaceId": "txn_8f2a1c9e",
  "projectId": "txn_8f2a1c9e"
}

Changes

No recorded changes to this operation across all 4 revisions of this API.