Skip to main content
PATCH
Update a webhook subscription

Authorizations

Authorization
string
header
required

API key passed as a Bearer token

Path Parameters

webhook_id
string
required

Body

application/json
url
string<uri> | null
Required string length: 1 - 2083
name
string | null

Optional label. Send a non-empty value to set/replace it, or an empty string to clear it. Omit to leave it unchanged.

Maximum string length: 100
events
enum<string>[] | null

Replace the subscribed event types (at least one). Preferred over event.

Webhook event types exposed to API clients.

Mirrors SynapseWebhookEventType enum in datalayer (camelCase) but rendered to clients as snake_case dotted strings (closer to Stripe convention and easier to grep in caller logs).

Available options:
scribe_session.created,
scribe_session.completed,
scribe_session.error,
scribe_session.updated,
scribe_session.cancelled,
scribe_session.deleted
event
enum<string> | null
deprecated

Deprecated: a single event type. Use events. When set and events is omitted, it replaces the subscription with a one-element list.

Available options:
scribe_session.created,
scribe_session.completed,
scribe_session.error,
scribe_session.updated,
scribe_session.cancelled,
scribe_session.deleted
isActive
boolean | null

Pause/resume delivery without deleting the subscription.

Response

Successful Response

A single webhook subscription.

id
string
required
url
string
required
events
enum<string>[]
required

Webhook event types exposed to API clients.

Mirrors SynapseWebhookEventType enum in datalayer (camelCase) but rendered to clients as snake_case dotted strings (closer to Stripe convention and easier to grep in caller logs).

Available options:
scribe_session.created,
scribe_session.completed,
scribe_session.error,
scribe_session.updated,
scribe_session.cancelled,
scribe_session.deleted
isActive
boolean
required
name
string | null

Optional human-readable label, or null if unset.

event
enum<string> | null
deprecated

Deprecated: the first subscribed event (events[0]). Use events.

Available options:
scribe_session.created,
scribe_session.completed,
scribe_session.error,
scribe_session.updated,
scribe_session.cancelled,
scribe_session.deleted
signingSecretPrefix
string | null

Display hint for the signing secret (e.g. 'whsec_a1b2c3d4'). The raw secret is only returned at creation/rotation.

signingSecretVersion
integer | null
createdAt
string | null
updatedAt
string | null
deletedAt
string | null