Seatmaps

Seatmaps

These events are emitted by the Inventory API (btrz-api-inventory) when seatmaps are created, updated, or deleted.

Events

Action Event name Endpoint
Create a seatmap seatmap.created POST /seatmaps
Update a seatmap seatmap.updated PUT /seatmaps/:seatmapId
Delete a seatmap seatmap.deleted DELETE /seatmaps/:id

Payload example created

{
  "attemptId": "b6a915dd-5765-4eb2-b6e2-593cd1a282f7",
  "created": 1719420554,
  "data": {
    "_id": "667c46598d5daa05239b40db",
    "accountId": "6526d94dbb4c1206536da021",
    "capacity": 57,
    "createdAt": {
      "offset": 0,
      "value": "2024-06-26T16:48:25.107Z"
    },
    "createdBy": "660eff3b8971e405c374e802",
    "name": "Test created",
    "sections": [
      {
        "_id": "667c46598d5daa05239b40da",
        "availableCols": 5,
        "availableRows": 15,
        "capacity": 57,
        "customSeats": [],
        "enumDir": 2,
        "enumType": 2,
        "facilities": [
          {
            "alignment": {
              "key": 2,
              "value": "Right"
            },
            "col": 5,
            "height": 1,
            "row": 1,
            "type": "door",
            "width": 1
          },
          {
            "alignment": {
              "key": 1,
              "value": "Left"
            },
            "col": 1,
            "height": 1,
            "label": "",
            "row": 1,
            "type": "driver",
            "width": 5
          }
        ],
        "lastRowNoGap": true,
        "name": "Main",
        "rowLabelRange": "",
        "rowLabelType": 1,
        "rowsEnumNoGaps": false,
        "seatLabelType": 1,
        "seatsPerRowLeft": 2,
        "seatsPerRowRight": 2,
        "seatsWithStatus": [],
        "showRowLabels": true,
        "startingRowLabel": "1",
        "startingSeatLabel": 1
      }
    ],
    "updatedAt": {
      "offset": 0,
      "value": "2024-06-26T16:48:25.107Z"
    },
    "updatedBy": "660eff3b8971e405c374e802"
  },
  "event": "seatmap.created",
  "id": "bf61b828-de7d-445a-a0b0-54073dac0c01",
  "livemode": false
}

Payload example updated

{
  "attemptId": "02381f5d-2a7f-4a2e-ad02-cd0e5eb70069",
  "created": 1719420867,
  "data": {
    "_id": "667c46598d5daa05239b40db",
    "accountId": "6526d94dbb4c1206536da021",
    "capacity": 57,
    "createdAt": {
      "offset": 0,
      "value": "2024-06-26T16:48:25.107Z"
    },
    "createdBy": "660eff3b8971e405c374e802",
    "name": "Test update",
    "sections": [
      {
        "_id": "667c46598d5daa05239b40da",
        "availableCols": 5,
        "availableRows": 15,
        "capacity": 57,
        "customSeats": [],
        "enumDir": 2,
        "enumType": 2,
        "facilities": [
          {
            "alignment": {
              "key": 2,
              "value": "Right"
            },
            "col": 5,
            "height": 1,
            "row": 1,
            "type": "door",
            "width": 1
          },
          {
            "alignment": {
              "key": 1,
              "value": "Left"
            },
            "col": 1,
            "height": 1,
            "label": "",
            "row": 1,
            "type": "driver",
            "width": 5
          }
        ],
        "lastRowNoGap": true,
        "name": "Main",
        "rowLabelRange": "",
        "rowLabelType": 1,
        "rowsEnumNoGaps": false,
        "seatLabelType": 1,
        "seatsPerRowLeft": 2,
        "seatsPerRowRight": 2,
        "seatsWithStatus": [],
        "showRowLabels": true,
        "startingRowLabel": "1",
        "startingSeatLabel": 1
      }
    ],
    "updatedAt": {
      "offset": 0,
      "value": "2024-06-26T16:53:53.096Z"
    },
    "updatedBy": "660eff3b8971e405c374e802"
  },
  "event": "seatmap.updated",
  "id": "41a3a56f-fa54-4cea-a6df-e88344ad24a7",
  "livemode": false
}

Payload example deleted

{
  "attemptId": "2691d56d-9207-4dec-a9d1-458949ea98cd",
  "created": 1719420950,
  "data": {
    "id": "667c46598d5daa05239b40db"
  },
  "event": "seatmap.deleted",
  "id": "a1394576-f7b2-4a2a-99e8-63eb59dfe596",
  "livemode": false
}

Field descriptions — payload (seatmap events)

Field Type Description
attemptId string UUID of the attempt that triggered the event.
created number Unix timestamp when the event was created.
event string Event name (seatmap.created, seatmap.updated, seatmap.deleted).
id string UUID of the webhook event.
livemode boolean Whether the event occurred in live mode.
data._id string Seatmap id (24 hex characters). For seatmap.deleted, use data.id instead.
data.id string Seatmap id (seatmap.deleted only).
data.accountId string Account id the seatmap belongs to.
data.name string Seatmap name.
data.capacity number Seatmap total capacity.
data.sections array Seatmap sections (each with name, customSeats, facilities, etc.).
data.standard boolean Whether this is a standard seatmap (used for manifests before assigning vehicle).
data.allowSeatOrientation boolean Whether seat orientation is enabled.
data.amenityGroupId string Amenity group ID (if entity hierarchy enabled).
data.brandId string Brand ID (if entity hierarchy enabled).
data.createdBy string User id that created this resource (24 hex).
data.updatedBy string User id that last updated this resource (24 hex).
data.createdAt object BzDate: creation date.
data.updatedAt object BzDate: last update date.