Skip to main content
WEBHOOK
messageReceived
{
  "account_id": "acct_01japd271aeatb7txrzr2xj8sg",
  "data": {
    "attachments": [
      {
        "id": "att_01jav8z6x1j4m1b3w8v2jz7j3r",
        "type": "image",
        "url": "https://toretto.family/image.jpg"
      }
    ],
    "body": "I don't have friends, I got family.",
    "conversation": {
      "contact": {
        "first_name": "Dominic",
        "id": "ctc_01ja88cboqffhswjx8zbak3ykk",
        "last_name": "Toretto",
        "phone_number": "+18015551234"
      },
      "id": "cnv_01jav8xy7fe4nsay3c9deqxge9",
      "phone_number": {
        "id": "pn_01jsjwe4d9fx3tpymgtg958d9w",
        "number": "+18015556789",
        "type": "local"
      }
    },
    "id": "msg_01jav96823f9x9054d6gyzpp16",
    "received_at": "2024-10-22T23:32:49Z"
  },
  "timestamp": "2024-10-21T23:29:41Z",
  "type": "message.received"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
account_id
string
required

The ID of the account in which this event occurred

​
data
object
required

The data associated with the event

​
timestamp
string<date-time>
required

The timestamp when this event occurred, in ISO8601 format

​
type
string
required

The type of the event. Always message.received for this event.

Allowed value: "message.received"

Response

200

Return a 200 status to indicate that the data was received successfully