Skip to content

List webhook deliveries

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

Lists delivery metadata and recorded attempts, newest deliveries first, for an existing workspace subscription. History expires 30 days after delivery creation. Event contents, signing secrets, and response bodies are excluded. An attempt with error unknown has no confirmed outcome; the recipient may have received it. runAt is the next scheduled retry or queue/request lease expiry. Attempts made before attempt history was introduced are not reconstructed.

webhookId
required
string

Unique identifier for the webhook.

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

string
subscriptionId
required

ID of the webhook subscription receiving the event.

string
eventId
required

ID of the event being delivered.

string
eventType
required

Type of event being delivered.

string
Allowed values: user.email_captured conversation.created conversation.closed conversation.reopened conversation.escalated message.created note.created
status
required

Current delivery state. succeeded means the endpoint accepted the event; failed and canceled are terminal.

string
Allowed values: pending queued delivering succeeded failed canceled
attempt
required

Number of delivery attempts started.

number
trigger
required

Whether delivery was triggered automatically or by a manual replay.

string
Allowed values: automatic manual
requestedAt
required

Time delivery was most recently requested.

string format: date-time
runAt
required

Next scheduled retry or queue/request lease expiry. Null when no further work is scheduled.

nullable string format: date-time
createdAt
required

Time the delivery was created.

string format: date-time
completedAt
required

Time the delivery reached a terminal state. Null while pending.

nullable string format: date-time
responseStatus
required

HTTP status from the latest recorded response.

nullable number
error
required

Latest recorded failure reason, or null when no error was recorded.

nullable string
attempts
required

Recorded HTTP attempts for this delivery. Older attempts may be absent from history.

array of dictionaries
Show child attributesHide child attributes
deliveryId
required

ID of the delivery this attempt belongs to.

string
attempt
required

Attempt number, starting at 1.

number
startedAt
required

Time the attempt started.

string format: date-time
completedAt
required

Time the attempt finished. Null if completion was not recorded.

nullable string format: date-time
durationMs
required

Duration of the attempt in milliseconds, if recorded.

nullable number
responseStatus
required

HTTP status returned by the endpoint, if a response was received.

nullable number
error
required

Failure reason, or null when no error was recorded. unknown means the outcome could not be confirmed.

nullable string
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.evnt_n5p8r2k6m4x9q3v7b1c0dfgh",
"subscriptionId": "hook_mR9kL3xN6pB2vQ8z_B8kN4pR6xZ2",
"eventId": "evnt_n5p8r2k6m4x9q3v7b1c0dfgh",
"eventType": "message.created",
"status": "succeeded",
"attempt": 1,
"trigger": "automatic",
"requestedAt": "2026-10-13T09:10:00.100Z",
"runAt": null,
"createdAt": "2026-10-13T09:10:00.100Z",
"completedAt": "2026-10-13T09:10:01.180Z",
"responseStatus": 200,
"error": null,
"attempts": [
{
"deliveryId": "hook_mR9kL3xN6pB2vQ8z_B8kN4pR6xZ2.evnt_n5p8r2k6m4x9q3v7b1c0dfgh",
"attempt": 1,
"startedAt": "2026-10-13T09:10:01.000Z",
"completedAt": "2026-10-13T09:10:01.180Z",
"durationMs": 180,
"responseStatus": 200,
"error": null
}
]
}
],
"nextCursor": null
}