Skip to main content
GET
List webhook deliveries
Each delivery represents one event sent to one endpoint. Filter by event_type, aggregate_id, status, or endpoint_id. Open a delivery to inspect its complete attempt history and response details.

Authorizations

x-api-key
string
header
required

Environment-specific API key created in the Unifystays portal

Headers

Query Parameters

event_type
string

Return only this exact event type.

Example:

"booking.confirmed"

aggregate_id
string

Return records for one aggregate, such as a Unifystays booking ID.

Example:

"ubk_eGQ0dW9uV1Vi"

status
enum<string>

Delivery status filter. Used by the deliveries endpoint.

Available options:
PENDING,
DELIVERING,
RETRYING,
SUCCEEDED,
EXHAUSTED,
CANCELLED
Example:

"EXHAUSTED"

endpoint_id
string<uuid>

Endpoint UUID filter. Used by the deliveries endpoint.

Example:

"8b95a9e0-4af3-4c6d-92df-84b64256d27f"

page
object

Page number, starting at 1.

limit
object

Records per page.

Response

200 - application/json

Webhook deliveries retrieved successfully.

data
object[]
required
meta
object
required