Seat-fees

Seat fees

These events are emitted by the Inventory API (btrz-api-inventory) when seat fees are created or updated. There is no DELETE endpoint for seat fees.

Events

Action Event name Endpoint
Create a seat fee seatfees.created POST /seat-fees
Update a seat fee seatfees.updated PUT /seat-fees/:seatfeeId

Payload example created / updated

The data object contains the full seat fee (for seatfees.created and seatfees.updated).

{
  "attemptId": "uuid",
  "created": 1628024835,
  "data": {
    "_id": "24 hex character id",
    "shortName": "PRM",
    "type": "$",
    "value": 10,
    "disabled": false,
    "bgcolor": "#d4eaf0",
    "name": "Premium",
    "lexiconKeys": { "name": { "key": "...", "values": {} } },
    "createdBy": "24 hex user id",
    "updatedBy": "24 hex user id",
    "createdAt": { "offset": 0, "value": "ISO date string" },
    "updatedAt": { "offset": 0, "value": "ISO date string" }
  },
  "event": "seatfees.created",
  "id": "uuid",
  "livemode": true
}

Field descriptions — payload (seat fee 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 (seatfees.created, seatfees.updated).
id string UUID of the webhook event.
livemode boolean Whether the event occurred in live mode.
data._id string Seat fee id (24 hex characters).
data.shortName string Seat fee short name (max 3 characters). Must be unique in the account.
data.type string Fee type: "$" (fixed) or "%" (percentage).
data.value number Numeric value (minimum 0.01).
data.disabled boolean Whether the seat fee is disabled (default false).
data.bgcolor string Background colour (e.g. hex).
data.name string Display name (from lexicon).
data.lexiconKeys object Lexicon key for name (key/values per language).
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.