Events
The events Booking Orbit sends to Orbit Exchange when appointments are booked, moved, cancelled or completed, what each carries, how they are delivered, and what uses them.
Reference3 min read
When an appointment is booked, moved, cancelled or completed, Booking Orbit records an event and sends it to Orbit Exchange, the hub that connects Orbit's products. Other products react to them there, and Orbit shows them under Exchange.
- Insights Orbit can count
booking.appointment.bookedas a goal, with its price as revenue. See Linked satellites. - Presence Orbit asks for a review after
booking.appointment.completed, and drops the request afterbooking.appointment.cancelled.
Note
Booking Orbit has no webhooks of its own. To receive these events in your own systems, an owner or admin sets up webhooks in Orbit. To follow a single appointment, read it with GET/manage/<token> in the public booking API.
The envelope
Every event has the same outer shape as events from Orbit's other products. Only data differs.
idtypebooking.appointment.booked.versiondata shape. It only goes up for a change that could break a receiver. All are 1 today.timesourcebooking.sequencetenant.organisationIdtenant fields are null.subject.resourceTypeappointment.subject.idactor.typeuser when someone on your team did it, system when a customer, the payment step or Booking Orbit did.actor.idnull for system.dataThe events
booking.appointment.bookedbooking.appointment.rescheduledbooking.appointment.cancelledbooking.appointment.completedbooking.appointment.noShowThe data
Every event carries:
appointmentIdlocationId, locationNorthwilds OsloserviceId, serviceBoot fittingstaffIdnullstartsAt, endsAtchannelbooking-page, widget, api, staff, ai, waitlist or orbitattendeesvalue, currency45000 and NOK, or null for free servicesbooking.appointment.rescheduled adds previousStartsAt. booking.appointment.cancelled adds by: customer, staff or system.
{ "id": "0c6b3965-5e25-4b18-8727-618828f9b347", "type": "booking.appointment.cancelled", "version": 1, "time": "2026-11-08T00:02:44.645Z", "source": "booking", "sequence": 17, "tenant": { "organisationId": "…", "spaceId": null, "environmentKey": null, "regionKey": null, "localeCode": null }, "subject": { "resourceType": "appointment", "id": "…" }, "actor": { "type": "system", "id": null }, "data": { "appointmentId": "…", "locationId": "…", "location": "Northwilds Oslo", "serviceId": "…", "service": "Ski service", "staffId": "…", "startsAt": "2026-11-12T07:00:00.000Z", "endsAt": "2026-11-12T08:00:00.000Z", "channel": "api", "attendees": 1, "value": 69000, "currency": "NOK", "by": "customer" }}Events carry no names, email addresses or answers of customers.
Delivery
Events are sent at least once. Each one waits in Booking Orbit until Orbit Exchange accepts it. If Exchange can't be reached, Booking Orbit tries again after 2 minutes, then waits twice as long each time, up to 12 hours between tries, for 12 tries in all. After that the event is no longer sent. Because a try can succeed even when the answer is lost, the same event can arrive twice: use id to spot it.
Was this page helpful?