Skip to content

List webhooks

GET
/webhooks
curl --request GET \
--url 'https://optlo.com/api/v1/webhooks?limit=50' \
--header 'Authorization: Bearer <token>'

Lists workspace subscriptions. Signing secrets are excluded. Active subscriptions receive matching new events.

limit
integer
default: 50 >= 1 <= 100

Maximum number of resources to return on one page.

cursor
string

Opaque cursor from the preceding page. Bound to workspace, resource and filters; survives key rotation.

Success

Media typeapplication/json
Show child attributesHide child attributes
data
required

Resources on this page.

array of dictionaries
Show child attributesHide child attributes
id
required

Unique identifier for the webhook subscription.

string
url
required

HTTPS endpoint that receives matching events.

string
types
required

Event types this subscription receives.

array of string
Allowed values: user.email_captured conversation.created conversation.closed conversation.reopened conversation.escalated message.created note.created
createdAt
required

Time the subscription was created.

string format: date-time
status
required

Whether the subscription is active or disabled. Disabled subscriptions receive no new events.

string
Allowed values: active disabled
disabledAt
required

Time the subscription was disabled, or null while active.

nullable string format: date-time
disabledReason
required

Reason the subscription was disabled: manually, an HTTP 410 response, or repeated failures. Null while active.

nullable string
Allowed values: manual gone failures
nextCursor
required

Pass this cursor to retrieve the next page. Null when no further page is available. When polling events in ascending order, retain the cursor even on empty pages.

nullable string

Example

{
"data": [
{
"id": "hook_mR9kL3xN6pB2vQ8z_B8kN4pR6xZ2",
"url": "https://example.com/webhooks/optlo",
"types": [
"message.created"
],
"createdAt": "2026-10-13T08:00:00.000Z",
"status": "active",
"disabledAt": null,
"disabledReason": null
}
],
"nextCursor": null
}