GET
/webhooksRetrieve a list of webhooksParameters
limitintegerqueryMaximum number of webhooks to return.
afterstring · uuidqueryPagination cursor to fetch results after this webhook ID. Cannot be used with 'before'.
beforestring · uuidqueryPagination cursor to fetch results before this webhook ID. Cannot be used with 'after'.
Responses
objectListWebhooksResponse
dataarray of objectArray containing webhook information.
Show child attributes
Show array items
created_atstring · date-timeTimestamp indicating when the webhook was created.
endpointstringThe URL where webhook events are sent.
eventsarray of stringArray of event types subscribed to.
Show child attributes
idstring · uuidThe ID of the webhook.
statusstringThe status of the webhook.
has_morebooleanIndicates if there are more results available.
objectstringType of the response object.
{
"data": [
{
"created_at": "2023-10-06T23:47:56.678Z",
"endpoint": "https://webhook.example.com/handler",
"events": [
"email.sent"
],
"id": "479e3145-dd38-476b-932c-529ceb705947",
"status": "enabled"
}
],
"has_more": false,
"object": "list"
}