Skip to main content
PATCH
Update Webhook Subscription

Authorizations

Authorization
string
header
required

Bearer API key issued from Settings → Developers.

Path Parameters

webhook_id
string<uuid>
required

ID of the webhook.

Body

application/json

Update Webhook Subscription payload

name
string | null

New name for the subscription.

Required string length: 1 - 255
url
string<uri> | null

New delivery URL.

Required string length: 1 - 2083
description
string | null

New description. Pass null to clear.

Maximum string length: 1000
event_types
enum<string>[] | null

New event-type filter.

Minimum array length: 1
Available options:
message.sent,
message.opened,
message.link_clicked,
message.replied,
invitation.sent,
invitation.accepted,
hot_lead.created,
meeting.created,
sequence.created,
sequence.paused,
sequence.resumed,
sequence.stopped,
sequence.completed,
task.created,
task.completed,
task.skipped,
task.reopened,
contact_entry.resolved,
event.resolved,
contact_exclusion.created
sequence_template_ids
string<uuid>[] | null

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

Minimum array length: 1
status
enum<string> | null

New lifecycle status.

Available options:
ACTIVE,
PAUSED,
DISABLED

Response

200 - application/json

Successful Response

id
string<uuid>
required

Unique identifier.

name
string
required

Name of the subscription.

url
string
required

Delivery URL events are POSTed to.

description
string | null
required

Free-form description.

event_types
enum<string>[]
required

Event types this subscription receives.

Available options:
message.sent,
message.opened,
message.link_clicked,
message.replied,
invitation.sent,
invitation.accepted,
hot_lead.created,
meeting.created,
sequence.created,
sequence.paused,
sequence.resumed,
sequence.stopped,
sequence.completed,
task.created,
task.completed,
task.skipped,
task.reopened,
contact_entry.resolved,
event.resolved,
contact_exclusion.created
sequence_template_ids
string<uuid>[] | null
required

Sequence-template scope.

status
enum<string>
required

Lifecycle status.

Available options:
ACTIVE,
PAUSED,
DISABLED
secret_prefix
string
required

Leading characters of the signing secret, safe to display.

created_at
string<date-time>
required

When the subscription was created.

updated_at
string<date-time>
required

When the subscription last changed.