Mit terminals settings

MIT terminals settings webhooks

This page documents webhook events related to MIT terminals settings from the Inventory API (mit-terminals-settings resource).

Inventory API – mit-terminals-settings resource

Emitted when an MIT terminal setting is created (POST /mit-terminals-settings), updated (PUT /mit-terminals-settings/:id), or deleted (DELETE /mit-terminals-settings/:id).

Events (Inventory API)

Action Event name Endpoint
Create an MIT terminal setting mitTerminalSettings.created POST /mit-terminals-settings
Update an MIT terminal setting mitTerminalSettings.updated PUT /mit-terminals-settings/:id
Delete an MIT terminal setting mitterminalsettings.deleted DELETE /mit-terminals-settings/:id

Payload example – created (Inventory API)

The data object for mitTerminalSettings.created is the full created MIT terminal setting (same shape as the API response mitTerminalSettings).

{
  "attemptId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "created": 1623794000,
  "data": {
    "_id": "60c92280d9e6c43f77b5a583",
    "name": "Setting 1",
    "operatingCompanyId": "5f243d100617680712e78dd7",
    "shiftLocationId": "5f243d100617680712e78dd7",
    "user": "terminal_user",
    "password": "***",
    "createdBy": "5f243d100617680712e78dd7",
    "updatedBy": "5f243d100617680712e78dd7",
    "createdAt": { "offset": 0, "value": "2021-06-15T12:00:00.000Z" },
    "updatedAt": { "offset": 0, "value": "2021-06-15T12:00:00.000Z" }
  },
  "event": "mitTerminalSettings.created",
  "id": "uuid",
  "livemode": true
}

Payload example – updated (Inventory API)

The data object for mitTerminalSettings.updated is the full updated MIT terminal setting (same shape as the API response mitTerminalSettings).

{
  "attemptId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "created": 1623794000,
  "data": {
    "_id": "60c92280d9e6c43f77b5a583",
    "name": "Setting 1",
    "operatingCompanyId": "5f243d100617680712e78dd7",
    "shiftLocationId": "5f243d100617680712e78dd7",
    "user": "terminal_user",
    "password": "***",
    "createdBy": "5f243d100617680712e78dd7",
    "updatedBy": "5f243d100617680712e78dd7",
    "createdAt": { "offset": 0, "value": "2021-06-15T12:00:00.000Z" },
    "updatedAt": { "offset": 0, "value": "2021-06-15T12:30:00.000Z" }
  },
  "event": "mitTerminalSettings.updated",
  "id": "uuid",
  "livemode": true
}

Payload example – deleted (Inventory API)

The data object for mitterminalsettings.deleted contains only the id of the deleted MIT terminal setting.

{
  "attemptId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "created": 1623794000,
  "data": {
    "id": "60c92280d9e6c43f77b5a583"
  },
  "event": "mitterminalsettings.deleted",
  "id": "uuid",
  "livemode": true
}

Field descriptions – data (created / updated)

data matches the Inventory API MitTerminalSetting schema. Main fields:

Field Type Description
_id string MIT terminal setting id (24 hex characters).
name string Name to represent the setting combination.
operatingCompanyId string Operating company associated to the credentials and shift location (24 hex characters).
shiftLocationId string Shift location associated to the credentials and the operating company (24 hex characters).
user string The user name to access the terminal.
password string The password to access the terminal.
createdBy string The user that created this resource.
updatedBy string The last user that updated this resource.
createdAt object The date the object was created (BzDate: offset, value).
updatedAt object The date the object was last updated (BzDate: offset, value).

Field descriptions – data (deleted)

Field Type Description
id string Id of the deleted MIT terminal setting (24 hex characters).