v3

OpenAPI 3.1.02026-07-2759128137.8 KB

webhooks

Update Webhook Subscription

Update mutable fields of a webhook subscription.

Requires the webhooks:write scope on the API key.

patch/v1/webhooks/{subscription_id}

subscription_idstring uuid required

ID of the subscription.

namestring nullable

New name for the subscription.

urlstring uri nullable

New delivery URL.

descriptionstring nullable

New description. Pass null to clear.

event_typesOutboundWebhookEventType[] nullable

New event-type filter.

sequence_template_idsstring[] nullable

New sequence-template scope. Pass null to receive events from all templates.

status'ACTIVE' | 'PAUSED' | 'DISABLED'

Successful Response

idstring uuid required

Unique identifier.

namestring required

Name of the subscription.

urlstring required

Delivery URL events are POSTed to.

descriptionstring nullable required

Free-form description.

event_typesOutboundWebhookEventType[] required

Event types this subscription receives.

sequence_template_idsstring[] nullable required

Sequence-template scope.

status'ACTIVE' | 'PAUSED' | 'DISABLED' required

secret_prefixstring required

Leading characters of the signing secret, safe to display.

created_atstring date-time required

When the subscription was created.

updated_atstring date-time required

When the subscription last changed.