Create Webhook Subscription - Topo

POST

/

v1

/

webhooks

Create Webhook Subscription

curl --request POST \
  --url https://api.topo.io/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "url": "<string>",
  "event_types": [],
  "description": "<string>",
  "sequence_template_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    url: '<string>',
    event_types: [],
    description: '<string>',
    sequence_template_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
  })
};

fetch('https://api.topo.io/v1/webhooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.topo.io/v1/webhooks"

payload = {
    "name": "<string>",
    "url": "<string>",
    "event_types": [],
    "description": "<string>",
    "sequence_template_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "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",
  "secret": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer API key issued from Settings → Developers.

Body

application/json

Create Webhook Subscription payload

name

string

required

Name of the subscription.

Required string length: 1 - 255

url

string<uri>

required

Endpoint that will receive POST deliveries.

Required string length: 1 - 2083

event_types

enum<string>[]

required

Event types this subscription should receive.

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

description

string | null

Free-form description.

Maximum string length: 1000

sequence_template_ids

string<uuid>[] | null

Restrict deliveries to events from these sequence templates.

Minimum array length: 1

Response

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

secret

string

required

Signing secret. Returned ONLY in this response — store it now, it is never returned again.

Create Webhook Subscription

curl --request POST \
  --url https://api.topo.io/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "url": "<string>",
  "event_types": [],
  "description": "<string>",
  "sequence_template_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    url: '<string>',
    event_types: [],
    description: '<string>',
    sequence_template_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
  })
};

fetch('https://api.topo.io/v1/webhooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.topo.io/v1/webhooks"

payload = {
    "name": "<string>",
    "url": "<string>",
    "event_types": [],
    "description": "<string>",
    "sequence_template_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "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",
  "secret": "<string>"
}