OperationalWebhookPayload

Agent operational event with a persisted Hub message identifier.

eventTypestringrequired

Possible values: [flag_for_review, session_transfer, end_chat]

timestampstring<date-time>required

expiresAtstring<date-time>nullable

payload objectrequired

providerstringrequired

Possible values: [whatsapp, instagram, messenger, telegram, sms, web_chatt2me]

directionstringrequired

Possible values: [IN]

message objectrequired

idstring<uuid>required

sessionIdstring<uuid>required

queue object

idstring<uuid>required

namestringrequired

reasonstringnullable

summarystringnullablerequired

sender objectrequired

idstringrequired

Stable channel routing identifier.

namestring

usernamestring

profilePicstring<uri>

phoneNumberstring

Optional visitor-provided, unverified phone number. Present only on Web Chatt inbound and operational-event senders; it is not a routing identifier.

Possible values: Value must match regular expression ^\\d{8,15}$

emailstring<email>

Optional visitor-provided, unverified email. Present only on Web Chatt inbound and operational-event senders; it is not a routing identifier.

applicationChannelIdstring<uuid>

recipient objectrequired

idstringrequired

Stable channel routing identifier.

namestring

usernamestring

profilePicstring<uri>

phoneNumberstring

Optional visitor-provided, unverified phone number. Present only on Web Chatt inbound and operational-event senders; it is not a routing identifier.

Possible values: Value must match regular expression ^\\d{8,15}$

emailstring<email>

Optional visitor-provided, unverified email. Present only on Web Chatt inbound and operational-event senders; it is not a routing identifier.

applicationChannelIdstring<uuid>

OperationalWebhookPayload

{
  "eventType": "flag_for_review",
  "timestamp": "2024-07-29T15:51:28.071Z",
  "expiresAt": "2024-07-29T15:51:28.071Z",
  "payload": {
    "provider": "whatsapp",
    "direction": "IN",
    "message": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "queue": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string"
      },
      "reason": "string",
      "summary": "string"
    },
    "sender": {
      "id": "string",
      "name": "string",
      "username": "string",
      "profilePic": "string",
      "phoneNumber": "string",
      "email": "[email protected]",
      "applicationChannelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    "recipient": {
      "id": "string",
      "name": "string",
      "username": "string",
      "profilePic": "string",
      "phoneNumber": "string",
      "email": "[email protected]",
      "applicationChannelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  }
}