MessageWebhookPayload

Normalized message event for WhatsApp, Instagram, Messenger, Telegram, SMS and Web chatt2.me. The message is persisted and its session is created or reused before this payload is delivered, including outbound-first and provider echo flows. Sandbox events carry the free Sandbox session identifier.

providerstringrequired

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

directionstringrequired

Possible values: [IN, OUT]

timestampinteger<int64>

message objectrequired

idstring<uuid>required

sessionIdstring<uuid>required

Session correlated with this message. Created on the first inbound or outbound when no active session exists.

typestringrequired

is_echoboolean

is_botboolean

is_sandboxboolean

isEditedboolean

content objectrequired

property name*any

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>

MessageWebhookPayload

{
  "provider": "whatsapp",
  "direction": "IN",
  "timestamp": 0,
  "message": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "string",
    "is_echo": true,
    "is_bot": true,
    "is_sandbox": true,
    "isEdited": true,
    "content": {}
  },
  "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"
  }
}