webhooks

Update Webhook Subscription

Update mutable fields of a webhook subscription.

Requires the webhooks:write scope on the API key.

patch/v1/webhooks/{webhook_id}

Request

  • Base URL: https://api.topo.io
  • URL: https://api.topo.io/v1/webhooks/{webhook_id}
  • Auth: HTTP bearer

Path parameters

webhook_idstring uuid required

ID of the webhook.

Request body

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'

Response

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.

Changes

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