Skip to main content
GET
List generated webhook events
Filter by exact event_type or aggregate_id. For booking events, the aggregate ID is the Unifystays booking_id. Results are newest first and include the payload delivered to subscribed endpoints. Event and completed delivery records are retained for 90 days.

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"

page
object

Page number, starting at 1.

limit
object

Records per page.

Response

200 - application/json

Webhook events retrieved successfully.

data
object[]
required
meta
object
required