Webhooks

Get webhook delivery history

GET https://demo.notifuse.com/api/webhookSubscriptions.deliveries

Returns the delivery history for a webhook subscription, including status and response information.

Authorizations

Authorization string header required

Bearer authentication header of the form Bearer <token>, where <token> is your API key.

Query Parameters

workspace_id string required

The ID of the workspace

Example ws_1234567890
subscription_id string

The ID of the webhook subscription (optional - if not provided, returns all deliveries for the workspace)

Example whsub_a1b2c3d4e5f6
status string

Only deliveries in this status (optional). An empty value lists every status; any other value answers 400. failed also covers the deliveries waiting for a retry, which go back to delivering when the worker takes them again. total counts the filtered deliveries.

Options pending, delivering, delivered, failed Example failed
limit integer

Number of deliveries to return (1-100)

Default 20 Min 1 Max 100 Example 20
offset integer

Offset for pagination

Default 0 Min 0 Example 0

Response

200 List of webhook deliveries object
deliveries object[]
Show 14 child attributes Hide 14 child attributes
id string

Unique identifier for the delivery

Example whdel_x1y2z3
subscription_id string

ID of the subscription this delivery belongs to

Example whsub_a1b2c3d4e5f6
event_type string

Type of event that triggered the delivery

Example contact.created
payload object

The JSON payload sent in the webhook

status string

Current status of the delivery

Options pending, delivering, delivered, failed Example delivered
attempts integer

Number of delivery attempts made

Example 1
max_attempts integer

Maximum number of retry attempts

Example 10
next_attempt_at string<date-time> | null

When the next retry will be attempted

Example 2024-01-15T10:35:00Z
last_attempt_at string<date-time> | null

When the last attempt was made

Example 2024-01-15T10:30:00Z
delivered_at string<date-time> | null

When the delivery was successfully completed

Example 2024-01-15T10:30:00Z
last_response_status integer | null

HTTP status code from the last attempt

Example 200
last_response_body string | null

Response body from the last attempt (truncated)

Example {"received": true}
last_error string | null

Error message from the last failed attempt

created_at string<date-time>

When the delivery was created

Example 2024-01-15T10:30:00Z
total integer

Total number of deliveries

Example 150
limit integer

Number of deliveries per page

Example 20
offset integer

Offset for pagination

Example 0
400 Bad request - missing parameters or unknown status object
error string required

Error message

401 Unauthorized - invalid or missing authentication token object
error string required

Error message

500 Internal server error object
error string required

Error message