Messages Any

message.any

Incoming messages (text/audio/media) for user or group chats. Fired for all message creations including your own. Fields:

hasMedia: boolean
_data: engine-specific internal data

Headers

x-userId

string

required

User UUID associated with the connected WhatsApp instance.

x-instanceId

string

required

Instance UUID of the connected WhatsApp instance.

Body

application/json

event

enum<string>

Available options:

message.any

data

object

Show child attributes

data.id

string

data.event

enum<string>

Available options:

message.any

data.metadata

object[]

data.me

object

Show child attributes

data.me.id

string

data.me.pushName

string

data.payload

object

Show child attributes

data.payload.id

string

data.payload.timestamp

integer<int32>

data.payload.from

string

data.payload.fromMe

boolean

data.payload.body

string

data.payload.hasMedia

boolean

data.payload.media

object

data.payload.ack

integer | null

data.payload.ackName

string

data.payload.replyTo

string | null

data.payload._data

object

Show child attributes

data.payload._data.key

object

Show child attributes

data.payload._data.key.remoteJid

string

data.payload._data.key.fromMe

boolean

data.payload._data.key.id

string

data.payload._data.messageTimestamp

integer<int32>

data.payload._data.pushName

string

data.payload._data.broadcast

boolean

data.payload._data.message

object

Show child attributes

data.payload._data.message.conversation

string

data.payload._data.message.messageContextInfo

object

Show child attributes

data.payload._data.message.messageContextInfo.deviceListMetadata

object

Show child attributes

data.payload._data.message.messageContextInfo.deviceListMetadata.senderKeyHash

string

data.payload._data.message.messageContextInfo.deviceListMetadata.senderTimestamp

string

data.payload._data.message.messageContextInfo.deviceListMetadata.recipientKeyHash

string

data.payload._data.message.messageContextInfo.deviceListMetadata.recipientTimestamp

string

data.payload._data.message.messageContextInfo.deviceListMetadataVersion

integer

data.payload._data.message.messageContextInfo.messageSecret

string

data.instanceId

string

data.userId

string

Response

200

The API successfully processed the batch of messages and returned a status of 200, confirming successful receipt and synchronization.

Overview

WhatsApp API

Whatsapp Webhooks

message.any

Headers

Body

Response

Overview

WhatsApp API

Whatsapp Webhooks

​message.any

Headers

Body

Response

message.any