Reservation Cancelled

BI CRM

The ReservationCancelled event is triggered whenever an existing reservation is cancelled.

JSON schema & example

Example payload

{
  "metadata": {
    "traceId": "19bebc7b-a2f6-4ca7-9b2e-912edc26d6d6",
    "occurredAt": "2024-12-11T14:42:55Z",
    "version": "1.0",
    "tenant": "1337",
    "type": "RESERVATION_CANCELLATION"
  },
  "reservationId": "12345",
  "cancelDateTime": "2022-05-24T07:15:29Z",
  "custom": {}
}

JSON Schema

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "metadata": {
      "type": "object",
      "properties": {
        "traceId": {
          "type": "string",
          "format": "uuid",
          "description": "Unique identifier to trace the event."
        },
        "occurredAt": {
          "type": "string",
          "format": "date-time",
          "description": "The timestamp when the event occurred."
        },
        "version": {
          "type": "string",
          "pattern": "^[0-9]+\\.[0-9]+$",
          "description": "The version of the event schema, following semantic versioning."
        },
        "tenant": {
          "type": "string",
          "description": "Identifier of the tenant or organization associated with the event."
        },
        "type": {
          "type": "string",
          "enum": [
            "CUSTOMER",
            "CUSTOMER_DELETED",
            "EVENT",
            "EVENT_CAPACITY",
            "ORDER",
            "CANCELLATION",
            "CREDIT_NOTE",
            "RESERVATION",
            "RESERVATION_CANCELLATION",
            "PRICE_PROFILE",
            "PRICE_PROFILE_DELETED",
            "TICKET"
          ],
          "description": "Identifier of the tenant or organization associated with the event."
        }
      },
      "required": [
        "traceId",
        "occurredAt",
        "version",
        "tenant",
        "type"
      ],
      "additionalProperties": false
    },
    "reservationId": {
      "type": "string",
      "description": "Unique identifier for the reservation."
    },
    "cancelDateTime": {
      "type": "string",
      "format": "date-time",
      "description": "\"ISO 8601 formatted date and time of the cancelled reservation.",
      "examples": [
        "2024-03-01T19:30:00Z"
      ]
    },
    "custom": {
      "type": "object",
      "description": "Custom data object"
    }
  },
  "additionalProperties": false
}