Service-numbers

Service numbers

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

Events

Action Event name Endpoint
Create a service number serviceNumber.created POST /service-numbers
Update a service number serviceNumber.updated PUT /service-numbers/:serviceNumberId

Payload example (created / updated)

The data object contains the full service number (for both events).

{
  "attemptId": "uuid",
  "created": 1628024835,
  "data": {
    "_id": "24 hex character id",
    "accountId": "24 hex account id",
    "name": "Service 101",
    "enabled": true,
    "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": "serviceNumber.created",
  "id": "uuid",
  "livemode": true
}

Field descriptions — payload (service number 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 (serviceNumber.created, serviceNumber.updated).
id string UUID of the webhook event.
livemode boolean Whether the event occurred in live mode.
data._id string Service number id (24 hex characters).
data.accountId string Account that owns the service number (24 hex).
data.name string Name of the service number.
data.enabled boolean Whether the service number is enabled (default true).
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.