List events — API — Awrora Docs

GET/api/v1/events

No scope required

Everything that has happened in the organization, newest first — the same envelopes webhooks deliver. Use it to catch up after downtime, or as a polling trigger instead of webhooks. Scopes are per event type, because an event carries the whole resource: booking.* needs "bookings:read", customer.* needs "customers:read", gift_card.* needs "gift_cards:read". Without ?type you get the types your key may read; asking for a type it may not read answers 403.

Query parameters#

Field	Type	Description
`limit`	integermin 1 · max 100 · default 25	How many results to return, 1-100. Defaults to 25.
`order`	stringdefault "desc"	Sort by creation time: "desc" (newest first, default) or "asc". `"asc""desc"`
`starting_after`	string≥ 1 chars	The next_cursor from a previous page. Opaque — pass it back verbatim.
`type`	string	Only events of this type. Omit to get every type your key may read. `"booking.created""booking.confirmed""booking.cancelled""booking.rescheduled""customer.created""customer.updated""gift_card.issued""gift_card.redeemed"`

Example request#

bash

curl -X GET "https://your-site.awrora.app/api/v1/events" \
  -H "Authorization: Bearer $AWRORA_API_KEY"

Responses#

200A page of events.
400Invalid request — codes "validation_failed" or, on an endpoint that requires one, "idempotency_key_required".
401Missing, invalid, revoked or expired API key — codes "api_key_missing", "api_key_invalid", "api_key_revoked", "api_key_expired".
403The API app is off, the plan does not include the API, or the key lacks the required scope — codes "app_not_enabled", "plan_upgrade_required", "insufficient_scope" (the last carries "required_scope").
429Rate limit exceeded — code "rate_limited". See the x-ratelimit-* headers.
500Something went wrong on our side — code "internal_error".

Response 200

Field Type Description

datarequired

object[]

The page of results, in the requested order.

Field Type Description

idrequired

string

Awrora id (UUID) for the event. Stable across retries — use it to deduplicate: the same event may be delivered more than once.

typerequired

string

Event type, e.g. "booking.created". "ping" is only sent by the test endpoint.

created_atrequired

string

When the event happened, ISO 8601 with the organization's offset.

api_versionrequired

string

The API version the payload follows. Matches info.version in the OpenAPI document.

datarequired

object

The payload. "object" is always the resource. Some types add fields next to it: "reason" on booking.cancelled, "previous_departure" on booking.rescheduled, "redeemed_amount" and "booking_id" on gift_card.redeemed.

Field Type Description

objectrequired

object

The resource the event is about, in the same shape the REST API returns it. Two deliberate differences: gift cards are the list form (GiftCardSummary, code_last4 only — fetch GET /v1/gift-cards/{id}?include=code when you need the code), and bookings carry manage_url as null (fetch GET /v1/bookings/{id} with a bookings:write key when you need it).

Field Type Description

idrequired

string

Awrora id (UUID) for the booking.

booking_numberrequired

integer | null

Sequential booking number within the organization, or null for legacy rows.

statusrequired

string

pending = created, awaiting payment; confirmed = active; cancelled = cancelled.

"pending""confirmed""cancelled"

sourcerequired

string | null

Where the booking came from: online, admin, agency, ai or api.

created_atrequired

string

ISO 8601 timestamp with offset.

updated_atrequired

string

ISO 8601 timestamp with offset.

experiencerequired

object

The experience that was booked.

departurerequired

object

The departure that was booked.

customerrequired

object

The guest details captured at checkout. Not the customer record — see /v1/customers.

guestsrequired

object[]

Guest lines. May be empty for legacy rows.

Field	Type	Description
`tier_id`required	string \| null	Id of the price tier, or null for legacy fixed guest types.
`tier_label`required	string	Guest type as shown to the buyer, e.g. "Vuxen".
`count`required	integermin -9007199254740991 · max 9007199254740991	Number of guests of this type.
`unit_price`required	object \| null	Price per guest of this type.

add_onsrequired

object[]

Add-on lines. Empty when none were bought.

Field	Type	Description
`id`required	string	Id of the add-on.
`label`required	string	Add-on name as shown to the buyer.
`count`required	integermin -9007199254740991 · max 9007199254740991	Quantity booked.
`unit_price`required	object \| null	Price per unit.

totalsrequired

object

Money totals for the booking.

Field	Type	Description
`subtotal`required	object \| null	Sum of guests and add-ons before discounts.
`discount`required	object \| null	Total discount applied. Zero when none.
`gift_card`required	object \| null	Amount paid with gift cards. Zero when none.
`total`required	object \| null	Amount the buyer owes or paid, after discounts and gift cards.

paymentrequired

object

How the booking is paid, and where that payment stands.

Field	Type	Description
`method`required	string \| null	Payment method as recorded at checkout, e.g. "Kort" or "Betala på plats".
`source`required	string	Where the money came from, not whether it arrived. stripe = Awrora took the payment (card or Stripe invoice); on_site = the guest pays the operator in person; external = the booking was paid in the operator's previous booking system and migrated in, so no refund can be issued through Awrora. Unlike "method", which is a human receipt label and is translated, this is a stable machine value. `"stripe""on_site""external"`
`status`required	string	paid = settled; pending = awaiting payment; scheduled = will be invoiced later; cancelled = booking or invoice voided; unpaid = written off; unknown = no payment state recorded. `"paid""pending""scheduled""cancelled""unpaid""unknown"`

noterequired

string | null

Free-text note from the buyer or staff, or null.

manage_urlrequired

string | null

Link where the guest can open and finish their own booking. Only returned to keys with the "bookings:write" scope — read-only keys and webhook/event payloads always get null, because anyone holding the link can see the booking and complete it. Also null when no valid link exists (no token, or the token has expired). Treat it as a secret.

resource_typerequired

string

What kind of thing the event is about: "booking", "customer", "gift_card" or "webhook".

resource_idrequired

string | null

Awrora id of that resource, or null for events without one.

has_morerequired

boolean

True when more results exist after this page. Fetch them with next_cursor.

next_cursorrequired

string | null

Pass this back as ?starting_after= to fetch the next page. Null when has_more is false. Opaque — do not parse it.

200 response

{
  "data": [
    {
      "id": "res_8f2k3n",
      "type": "string",
      "created_at": "string",
      "api_version": "string",
      "data": {
        "object": {
          "id": "res_8f2k3n",
          "booking_number": null,
          "status": "pending",
          "source": "string",
          "created_at": "string",
          "updated_at": "string",
          "experience": {
            "id": null,
            "title": null,
            "slug": null
          },
          "departure": {
            "id": null,
            "starts_at": null,
            "ends_at": null
          },
          "customer": {
            "name": null,
            "email": null,
            "phone": null
          },
          "guests": [
            null
          ],
          "add_ons": [
            null
          ],
          "totals": {
            "subtotal": null,
            "discount": null,
            "gift_card": null,
            "total": null
          },
          "payment": {
            "method": null,
            "source": null,
            "status": null
          },
          "note": "string",
          "manage_url": "https://example.com/webhooks/awrora"
        }
      },
      "resource_type": "string",
      "resource_id": "resource_8f2k3n"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}