# 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.

Source: https://docs.bifrostorbit.com/booking/developers/events/

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.booked` as a goal, with its price as revenue. See [Linked satellites](https://docs.bifrostorbit.com/booking/everyone/orbit-connections/).
- **Presence Orbit** asks for a review after `booking.appointment.completed`, and drops the request after `booking.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](https://docs.bifrostorbit.com/orbit/developers/orbit-webhooks/). To follow a single appointment, read it with `GET /manage/<token>` in the [public booking API](https://docs.bifrostorbit.com/booking/developers/public-api/).

## The envelope

Every event has the same outer shape as events from Orbit's other products. Only `data` differs.

| Field | What it holds |
| --- | --- |
| `id` | A unique ID (UUID) for this event. Use it to spot duplicates. |
| `type` | The event name, such as `booking.appointment.booked`. |
| `version` | The version of this event's `data` shape. It only goes up for a change that could break a receiver. All are `1` today. |
| `time` | When it happened, in UTC. |
| `source` | Always `booking`. |
| `sequence` | A number that goes up with each event from your organisation. |
| `tenant.organisationId` | Your organisation. The other `tenant` fields are `null`. |
| `subject.resourceType` | Always `appointment`. |
| `subject.id` | The appointment's ID. |
| `actor.type` | `user` when someone on your team did it, `system` when a customer, the payment step or Booking Orbit did. |
| `actor.id` | The person's ID, or `null` for `system`. |
| `data` | The details below. |

## The events

| Event | When |
| --- | --- |
| `booking.appointment.booked` | An appointment is booked: on the booking page, the widget, the API, by your team, the assistant or from the waitlist. |
| `booking.appointment.rescheduled` | An appointment moves to another time. |
| `booking.appointment.cancelled` | An appointment is cancelled, or released because its payment wasn't completed in time. |
| `booking.appointment.completed` | Your team, or an AI assistant for them, marks an appointment as done. |
| `booking.appointment.noShow` | Your team, or an AI assistant for them, marks an appointment as a no-show. |

## The data

Every event carries:

| Field | |
| --- | --- |
| `appointmentId` | The appointment |
| `locationId`, `location` | The location's ID and name, such as `Northwilds Oslo` |
| `serviceId`, `service` | The service's ID and name, such as `Boot fitting` |
| `staffId` | The person, or `null` |
| `startsAt`, `endsAt` | In UTC |
| `channel` | Where it was booked: `booking-page`, `widget`, `api`, `staff`, `ai`, `waitlist` or `orbit` |
| `attendees` | How many people are booked on it and not cancelled |
| `value`, `currency` | The price in the currency's smallest unit, such as `45000` and `NOK`, or `null` for free services |

`booking.appointment.rescheduled` adds `previousStartsAt`. `booking.appointment.cancelled` adds `by`: `customer`, `staff` or `system`.

```json
{
  "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.
