Skip to main content

Events

Every mutation through the API records an event under the site and delivers it to the enabled webhook endpoints. The events API is the audit log and webhook debugger.

The event object​

{
"id": "evt_1a2b3c",
"object": "event",
"type": "booking.confirmed",
"livemode": true,
"created": 1793061121,
"data": {
"object": { ...the booking... },
"previous_attributes": {"status": "hold"}
}
}

Endpoints​

MethodPathDescription
GET/v1/eventsList, newest first (limit, cursors)
GET/v1/events/{id}Retrieve

Event-type filtering is not offered in v1 (it would require an extra Firestore index) — page and filter client-side, or record events of interest in your webhook consumer.

Event types​

TypeWhen
booking.created / booking.updatedBooking lifecycle
booking.confirmed / booking.cancelledStatus transitions
customer.*, accommodation.*, pitch.*Directory and catalog mutations
meter_reading.createdSingle or bulk-ingested readings (one event per reading)
invoice.createdXero invoice generated
rate.updated / rates.bulk_updatedRate sheet changes
webhook_endpoint.*Endpoint lifecycle