Skip to content

List webhook delivery attempts

GET
/api/v1/webhooks/{webhook_id}/deliveries
webhook_id
required
Webhook Id
string format: uuid
status
Any of:
string
limit
Limit
integer
default: 100 >= 1 <= 500
offset
Offset
integer
0

Successful Response

WebhookDeliveryListResponse

Response body for GET /api/v1/webhooks/{id}/deliveries.

object
deliveries
required
Deliveries
Array<object>
WebhookDeliveryResponse

Webhook delivery record as returned from the API.

object
id
required
Id
string format: uuid
webhook_id
required
Webhook Id
string format: uuid
event_type
required
Any of:
string
Allowed values: execution.completed execution.failed storage.object.created
event_id
required
Event Id

Source event id (idempotency key).

string
payload
required
Payload

Full payload as sent to the consumer.

object
key
additional properties
any
status
required
Status
string
Allowed values: pending delivered dead_letter
attempts
required
Attempts

Number of delivery attempts made.

integer
next_retry_at
Any of:
string format: date-time
last_attempt_at
Any of:
string format: date-time
response_status
Any of:
integer
response_body
Any of:
string
error_message
Any of:
string
created_at
required
Created At
string format: date-time
total
required
Total
integer
limit
required
Limit
integer
offset
required
Offset
integer
has_more
required
Has More
boolean

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object