Users

User webhooks are emitted by the Accounts API when users or user sequences are created, updated, or deleted (PUT /users/:userId, DELETE /users/:id, POST /users/:userId/sequences, PUT /users/:userId/sequences/:sequenceId, PATCH /users/:userId/sequences/:sequenceId with operation transfer).

Events

Action Event name
creating a user via admin panel user.created
account sign up (new account) user.created
creating a new network agency user.created
editing a user (PUT /users/:userId) user.updated
deleting a user (DELETE /users/:id) user.deleted
adding sequence to a user (POST /users/:userId/sequences) users.sequence.created
updating user sequence (PUT or PATCH /users/:userId/sequences/:sequenceId) users.sequence.updated

Payload example (user.updated)

{
  "id": "string",
  "attemptId": "string",
  "livemode": "boolean",
  "created": "int",
  "event": "user.updated",
  "data": {
    "_id": "string",
    "accountId": "string",
    "agencyId": "string",
    "defaultMenu": "string",
    "display": "string",
    "domain": "string",
    "email": "string",
    "firstName": "string",
    "language": "string",
    "lastName": "string",
    "preferredLocationId": "string",
    "preferredStationId": "string",
    "rootDomain": "string",
    "scannerKey": "string",
    "deleted": "boolean",
    "createdAt": {
      "value": "string",
      "offset": "int"
    },
    "updatedAt": {
      "value": "string",
      "offset": "int"
    }
  }
}

Payload fields (user.updated)

Field Type Description
data._id string User id (ObjectId)
data.accountId string Account id (ObjectId)
data.agencyId string Agency id (ObjectId)
data.defaultMenu string Default menu path
data.display string Display name
data.domain string User domain
data.email string User email
data.firstName string First name
data.language string Preferred language
data.lastName string Last name
data.preferredLocationId string Preferred location id (ObjectId)
data.preferredStationId string Preferred station id (ObjectId)
data.rootDomain string Root domain
data.scannerKey string Scanner key
data.deleted boolean Whether the user is marked deleted
data.createdAt object Creation timestamp (value, offset)
data.updatedAt object Last update timestamp (value, offset)

Payload example (user.deleted)

{
  "id": "string",
  "attemptId": "string",
  "livemode": "boolean",
  "created": "int",
  "event": "user.deleted",
  "data": {
    "id": "507f1f77bcf86cd799439011"
  }
}

Payload fields (user.deleted)

Field Type Description
data.id string Id of the deleted user (ObjectId)

Payload example sequence created

{
  "attemptId": "23c751bb-778a-48a1-9ab3-976db1308ce5",
  "created": 1685652883,
  "data": {
    "createdAt": {
      "offset": 0,
      "value": "2023-06-01T20:53:29.339Z"
    },
    "createdBy": "633edae0f319760686fb4f59",
    "discriminatorId": "CLD",
    "fillCharacter": "0",
    "length": 15,
    "postfix": "S",
    "prefix": "E",
    "sequenceEnd": 500,
    "sequenceId": "6479054997bd08037f201084",
    "sequenceStart": 100,
    "type": "test",
    "updatedAt": {
      "offset": 0,
      "value": "2023-06-01T20:53:29.339Z"
    },
    "updatedBy": "633edae0f319760686fb4f59",
    "validTo": {
      "offset": 0,
      "value": "2023-06-30T00:00:00.000Z"
    }
  },
  "event": "users.sequence.created",
  "id": "1a6e53aa-bc8d-4652-ab22-3e6425949cc1",
  "livemode": false
}

Payload example sequence updated

{
  "attemptId": "ec728edd-2900-4dc6-afa4-a2a3a97f3048",
  "created": 1708967235,
  "data": {
    "_id": "64b985217a951802f83a81c2",
    "accountId": "52a377ec430c7d4e220001fc",
    "createdAt": {
      "offset": 0,
      "value": "2023-07-20T19:04:01.836Z"
    },
    "createdBy": null,
    "currentValue": 106,
    "discriminatorId": "64b98404d9e2430d1df7be4b",
    "fillCharacter": "0",
    "length": 15,
    "postfix": "-R4",
    "prefix": "R3-",
    "sequenceEnd": 110,
    "sequenceStart": 100,
    "type": "test",
    "updatedAt": {
      "offset": 0,
      "value": "2024-02-26T17:06:19.379Z"
    },
    "updatedBy": null,
    "validFrom": {
      "offset": 0,
      "value": "2023-07-20T03:00:00.000Z"
    },
    "validTo": {
      "offset": 0,
      "value": "2023-10-05T02:59:59.000Z"
    }
  },
  "event": "users.sequence.updated",
  "id": "26e4b193-3a52-4b31-81b4-fd8c5dc55d36",
  "livemode": false
}

Payload fields (users.sequence.created)

Field Type Description
data.sequenceId string Sequence id (ObjectId)
data.type string Sequence type
data.prefix string Prefix for generated values
data.postfix string Postfix for generated values
data.length number Length of the sequence number part
data.fillCharacter string Character used to pad the number
data.sequenceStart number Start value
data.sequenceEnd number End value
data.discriminatorId string Discriminator id (ObjectId)
data.validTo object Validity end (value, offset)
data.createdAt object Creation timestamp (value, offset)
data.updatedAt object Last update timestamp (value, offset)
data.createdBy string User id that created the sequence (ObjectId)
data.updatedBy string User id that last updated the sequence (ObjectId)

Payload fields (users.sequence.updated)

Field Type Description
data._id string Sequence document id (ObjectId)
data.accountId string Account id (ObjectId)
data.currentValue number Current sequence value
data.discriminatorId string Discriminator id (ObjectId)
data.type string Sequence type
data.prefix string Prefix for generated values
data.postfix string Postfix for generated values
data.length number Length of the sequence number part
data.fillCharacter string Character used to pad the number
data.sequenceStart number Start value
data.sequenceEnd number End value
data.validFrom object Validity start (value, offset)
data.validTo object Validity end (value, offset)
data.createdAt object Creation timestamp (value, offset)
data.updatedAt object Last update timestamp (value, offset)
data.createdBy string User id that created the sequence (ObjectId)
data.updatedBy string User id that last updated the sequence (ObjectId)