External bookings

Events

Action Event name
create an external booking (POST /operations/external-bookings) externalbookings.created
delete an external booking (DELETE /operations/external-bookings/{ticketId}) externalbookings.deleted

Payload example (externalbookings.created)

The payload is the object passed to the webhook emitter: providerId, apiKey, and data (the ticket as returned by POST /operations/external-bookings).

{
  "providerId": "string",
  "apiKey": "string",
  "data": {
    "_id": "string",
    "ticketNumber": "string",
    "createdAt": {},
    "updatedAt": {}
  }
}

Payload fields (externalbookings.created)

Field Type Description
providerId string Account ID of the provider (operations account).
apiKey string API key used for the request.
data object The created external booking ticket (same structure as the ticket in the POST /operations/external-bookings response).
data._id string Ticket ID (24 hex characters).
data.ticketNumber string Ticket number (e.g. 6-character string).
data.createdAt object Creation timestamp.
data.updatedAt object Last update timestamp.

Payload example (externalbookings.deleted)

The payload is the object passed to the webhook emitter: providerId, apiKey, and data (the deleted ticket as returned by DELETE /operations/external-bookings/{ticketId}).

{
  "providerId": "string",
  "apiKey": "string",
  "data": {
    "_id": "string",
    "ticketNumber": "string"
  }
}

Payload fields (externalbookings.deleted)

Field Type Description
providerId string Account ID of the provider (operations account).
apiKey string API key used for the request.
data object The deleted external booking ticket (same structure as the ticket in the DELETE /operations/external-bookings/{ticketId} response).
data._id string Ticket ID (24 hex characters).
data.ticketNumber string Ticket number.