Nome

Tipo

Descrição

Exemplos

v

string

Versão do formato da notificação.

"1.1"

type

string

Tipo de notificação.

"message"

chatPlatform

string

Plataforma de chat.

"webchat", "whatsapp", "messenger", "telegram", "twitter"

contactId

string

Identificador do contato na plataforma de chat. <br> WhatsApp: Número de telefone do usuário. <br> Messenger, Telegram, Twitter: ID do usuário na plataforma.

"+5511999999999", "1234567890"

whatsappNumber

string

Número de telefone da linha do bot (somente para WhatsApp).

"+551149331774"

chatIdInChatPlatform

string

ID do chat na plataforma de chat (exceto WhatsApp).

"AR4Q1S3P1U"

chatChannelId

string

ID do canal de chat no Botmaker.

"canal123"

customerId

string

ID do usuário no Botmaker.

"user456"

firstName

string

Nome do usuário.

"João"

lastName

string

Sobrenome do usuário.

"da Silva"

customerCreationTime

string

Data e hora de criação do usuário (formato ISO 8601).

"2021-02-28T23:59:00.147Z"

sessionCreationTime

string

Data e hora de início da sessão (formato ISO 8601).

"2021-03-08T19:28:45.147Z"

whatsappNickName

string

Apelido do usuário no WhatsApp.

"Joãozinho"

txId

string

ID da transação quando templates são enviados pela API do Botmaker. Corresponde ao webhookNotificationId.

"tx789"

messages

array

Array de mensagens.

[{ "_id": "PHW3S2KV4...", ... }]

messages[]._id

string

ID da mensagem no Botmaker.

"PHW3S2KV4VRWL17BBM1U"

messages[].date

string

Data e hora da mensagem (formato ISO 8601).

"2021-03-08T19:44:14.388Z"

messages[].message

string

Texto da mensagem.

"Olá, como vai?"

messages[].fromName

string

Nome de quem enviou a mensagem ("Bot", nome de usuário ou operador).

"Ignacio Ferrari", "Bot"

messages[].from

string

Categoria do remetente.

"bot", "user", "operator"

messages[].fromCustomer

boolean

true se a mensagem for do usuário, undefined caso contrário.

true, undefined

messages[].isButton

boolean

true se a mensagem for um botão, undefined caso contrário.

true, undefined

messages[].hasAttachment

boolean

true se a mensagem tiver um arquivo anexo, undefined caso contrário.

true, undefined

messages[].image

string

URL da imagem (se aplicável).

"https://..."

messages[].audio

string

URL do áudio (se aplicável).

"https://..."

messages[].video

string

URL do vídeo (se aplicável).

"https://..."

messages[].file

string

URL do arquivo (se aplicável).

"https://..."

messages[].operatorId

string

ID do operador no Botmaker (se from for "operator").

"bxj99dyfxEsdopib9ZuboIG5Tqr3"

messages[].operatorName

string

Nome do operador (se from for "operator").

"Pepe"

messages[].operatorEmail

string

Email do operador (se from for "operator").

"pepe@domain.com"

messages[].operatorRole

string

Função (role) do operador (se from for "operator").

"ADMIN", "CONFIGURATOR", "SUPERVISOR", "OPERATOR", nomeFuncaoCustomizada

messages[].queue

string

ID da fila de atendimento (se aplicável).

"idFilaAtendimento"

messages[].intentName

string

Nome da intenção (se from for "bot").

"Nome de uma Intenção"

messages[].location

string

Latitude e longitude (para geolocalização no WhatsApp).

"lat & long"

messages[].caption

string

Texto que acompanha uma imagem (WhatsApp).

"Descrição da imagem"

messages[].payload

string

Payload configurado pelo usuário (para HSM/templates com botões).

"payload_data"

messages[].button

string

Rótulo do botão HSM.

"Botão 1"

messages[].templateName

string

Nome do template com botão.

"Nome do template"

messages[].clientPayload

string

Payload enviado através da API do Botmaker.

"client_payload_data"

messages[].whatsappReferral

object

Informações de referência do WhatsApp.

{ "sourceId": "...", ... }

messages[].whatsappReferral.sourceId

string

ID da fonte de referência.

"source123"

messages[].whatsappReferral.sourceURL

string

URL da fonte de referência.

"https://..."

messages[].whatsappReferral.headline

string

Título da referência.

"Título da referência"

messages[].whatsappReferral.body

string

Corpo da referência.

"Texto da referência"

messages[].cart

object

Informações do carrinho de compras.

{ "products": [...] }

messages[].cart.products

array

Array de produtos no carrinho.

[{ "sku": "sku123", "quantity": 2 }]

messages[].cart.products[].sku

string

SKU do produto.

"sku123"

messages[].cart.products[].quantity

number

Quantidade do produto.

2

variables

object

Mapa de variáveis e seus novos valores.

{ "varName1": "new val 1", "varName2": "new val 2" }