Skip to main content
PATCH
/
v1
/
webhooks
/
{subscription_id}
Update Webhook Subscription
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    url: '<string>',
    description: '<string>',
    event_types: [],
    sequence_template_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
  })
};

fetch('https://api.topo.io/v1/webhooks/{subscription_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "url": "<string>",
  "description": "<string>",
  "event_types": [],
  "sequence_template_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "secret_prefix": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer API key issued from Settings → Developers.

Path Parameters

​
subscription_id
string<uuid>
required

ID of the subscription.

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
​
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
​
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.