Service types

Service types

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

Events

Action Event name Endpoint
Create a service type servicetypes.created POST /service-types
Update a service type servicetypes.updated PUT /service-types/:serviceTypeId
Delete a service type servicetypes.deleted DELETE /service-types/:serviceTypeId

Payload example for created

{
  "attemptId": "ad10262f-b86b-434d-8d4b-4233207a921b",
  "created": 1623785692,
  "data": {
    "_id": "60c900cb3d6d6319a44fff78",
    "accountId": "52a377ec430c7d4e220001fc",
    "createdAt": {
      "offset": 0,
      "value": "2021-06-15T19:34:35.394Z"
    },
    "createdBy": "55fc2f318791db6e1a0000b6",
    "enabled": true,
    "lexiconKeys": {
      "name": "52a377ec430c7d4e220001fc-name-18e03bd4-8ec0-403e-bb66-2b390fd87f1d-e2041f7c-7622-4a88-9d0d-6e18f59e7763"
    },
    "shipTrackId": "Id1",
    "updatedAt": {
      "offset": 0,
      "value": "2021-06-15T19:34:35.394Z"
    },
    "updatedBy": "55fc2f318791db6e1a0000b6"
  },
  "event": "servicetypes.created",
  "id": "bc9a097c-57aa-40b0-92e0-a81e8a062278",
  "livemode": false
}

Payload example for updated

{
  "attemptId": "b8c61b3e-69be-4470-be00-3aa05e860532",
  "created": 1623785692,
  "data": {
    "_id": "60c900cb3d6d6319a44fff78",
    "accountId": "52a377ec430c7d4e220001fc",
    "createdAt": {
      "offset": 0,
      "value": "2021-06-15T19:34:35.394Z"
    },
    "createdBy": "55fc2f318791db6e1a0000b6",
    "enabled": false,
    "lexiconKeys": {
      "name": "52a377ec430c7d4e220001fc-name-18e03bd4-8ec0-403e-bb66-2b390fd87f1d-e2041f7c-7622-4a88-9d0d-6e18f59e7763"
    },
    "shipTrackId": "Id2",
    "updatedAt": {
      "offset": 0,
      "value": "2021-06-15T19:34:47.371Z"
    },
    "updatedBy": "55fc2f318791db6e1a0000b6"
  },
  "event": "servicetypes.updated",
  "id": "2db3a5a6-48fa-467c-9bd3-243b0059e01b",
  "livemode": false
}

Payload example deleted

{
  "attemptId": "ecff765c-c075-414a-9d95-455fb5d7f697",
  "created": 1623785655,
  "data": {
    "serviceTypeId": "60a299b3e8fe7e059067ebfe"
  },
  "event": "servicetypes.deleted",
  "id": "35a9c1b5-3491-4887-aec0-f0ff9a3a024a",
  "livemode": false
}

Field descriptions — payload (service type 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 (servicetypes.created, servicetypes.updated, servicetypes.deleted).
id string UUID of the webhook event.
livemode boolean Whether the event occurred in live mode.
data._id string Service type id (24 hex characters).
data.accountId string Account that owns the service type (24 hex).
data.name string Default name for the service type (from lexicon).
data.lexiconKeys object Lexicon keys for the service type (e.g. name key).
data.shipTrackId string Ship/track identifier for the service type.
data.paymentMethodIds array Payment method UUIDs associated with this service type.
data.enabled boolean Whether the service type is enabled (disabled types are not shown in purchase flow).
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.
data.serviceTypeId string Service type id (servicetypes.deleted only).