List Webhook Subscriptions
List the webhook subscriptions configured in the workspace.
Requires the webhooks:read scope on the API key.
GET
/
v1
/
webhooks
List Webhook Subscriptions
curl --request GET \
--url https://api.topo.io/v1/webhooks \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
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"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"url": "<string>",
"description": "<string>",
"event_types": [
"message.sent"
],
"sequence_template_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"status": "ACTIVE",
"secret_prefix": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"total_count": 123,
"total_pages": 123,
"has_more": true
}Authorizations
Bearer API key issued from Settings → Developers.
Query Parameters
Page number.
Required range:
x >= 1Number of items per page.
Required range:
1 <= x <= 100Response
200 - application/json
Successful Response
Records on this page.
Hide child attributes
Hide child attributes
Unique identifier.
Name of the subscription.
Delivery URL events are POSTed to.
Free-form description.
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 scope.
Lifecycle status.
Available options:
ACTIVE, PAUSED, DISABLED Leading characters of the signing secret, safe to display.
When the subscription was created.
When the subscription last changed.
Total number of records matching the query.
Total number of pages.
Whether more pages remain after the current one.
Was this page helpful?
⌘I
List Webhook Subscriptions
curl --request GET \
--url https://api.topo.io/v1/webhooks \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
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"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"url": "<string>",
"description": "<string>",
"event_types": [
"message.sent"
],
"sequence_template_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"status": "ACTIVE",
"secret_prefix": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"total_count": 123,
"total_pages": 123,
"has_more": true
}