Webhook de Mensagens de Bot

Configuração: Configurado diretamente na integração do Bot no nexus-chat

Dispara quando uma nova mensagem é encaminhada a um bot integrado ao nexus-chat. Permite integrar sistemas de atendimento automático com a plataforma do Nexus.

Payload

Campo	Tipo	Descrição
`event_id`	string (uuid)	Identificador único do evento (UUID v4).
`type`	string	Sempre `"message"` neste webhook.
`message`	object	Dados da mensagem recebida.
`ticket`	object	Dados do ticket associado.
`whatsapp`	object	Dados do WhatsApp que recebeu a mensagem.
`contact`	object	Dados do contato remetente.
`context`	object	Variáveis de contexto personalizadas.

Objeto `message`

Campo	Tipo	Descrição
`id`	string	ID da mensagem no sistema.
`from`	string	Número de origem (cliente).
`to`	string	Número de destino (bot/empresa).
`from_me`	boolean	Se foi enviada pelo atendente/bot.
`from_bot`	boolean	Se foi enviada por um bot.
`user_id`	integer \| null	ID do usuário que enviou.
`type`	string	Tipo da mensagem (text, image, etc).
`text`	string	Conteúdo textual da mensagem.
`postback_text`	string \| null	Texto de callback de Quick Reply.
`file`	string \| null	URL do arquivo enviado.
`datetime`	string (date-time)	Data e hora do envio.

Objeto `ticket`

Campo	Tipo	Descrição
`id`	integer	ID do ticket.
`uuid`	string	UUID do ticket.
`tracking_id`	integer	Código de rastreamento.
`campaign_id`	integer \| null	ID da campanha associada.
`request_id`	string \| null	ID da requisição original.
`cost_center_id`	integer \| null	ID do centro de custo.
`status`	string	Status atual do ticket.
`user_id`	integer \| null	ID do usuário atendente.
`contact_id`	integer	ID do contato.
`queue_id`	integer	ID da fila de atendimento.
`transfer_queue_id`	integer	ID da fila de transferência.
`whatsapp_id`	integer	ID do número do ticket.
`integration_id`	integer \| null	ID da integração.
`from_me`	boolean	Se o atendimento foi iniciado pelo sistema.

Objeto `whatsapp`

Campo	Tipo	Descrição
`id`	integer	ID do número de WhatsApp.
`name`	string	Nome da empresa/entidade.
`number`	string	Número do WhatsApp.

Objeto `contact`

Campo	Tipo	Descrição
`id`	integer	ID do contato.
`name`	string	Nome do contato.
`number`	string	Número de telefone.
`document`	string \| null	Documento (CPF/CNPJ).
`email`	string \| null	Email do contato.
`is_group`	boolean	Se é um grupo.
`created_at`	string (date-time)	Data de criação.
`updated_at`	string (date-time)	Data de atualização.
`extra_info`	array	Lista de dados adicionais.

Exemplo - Mensagem de Texto

{
  "event_id": "j50h2i30-sg2p-g5r8-o150-ii0099ii4444",
  "type": "message",
  "message": {
    "id": "00wamid.HBgMNUMyMDAwMDAwMDAwFQIAEhgUAAAAAAAABBBBCCCCDDDDEEEEFFFF000011112222",
    "from": "559999999999",
    "to": "5511999999999",
    "from_me": false,
    "from_bot": false,
    "user_id": null,
    "type": "text",
    "text": "QUERO MAIS",
    "postback_text": null,
    "file": null,
    "datetime": "2025-07-21T14:54:36.487-03:00"
  },
  "ticket": {
    "id": 12345,
    "uuid": "abcd1234-abcd-1234-abcd-1234567890ab",
    "tracking_id": 987654,
    "campaign_id": 10,
    "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "cost_center_id": 1,
    "status": "pending",
    "user_id": null,
    "contact_id": 54321,
    "queue_id": 5,
    "transfer_queue_id": 2,
    "whatsapp_id": 3,
    "integration_id": 1,
    "from_me": false
  },
  "whatsapp": {
    "id": 3,
    "name": "Empresa Fictícia Tecnologia Ltda",
    "number": "5511999999999"
  },
  "contact": {
    "id": 54321,
    "name": "João da Silva",
    "number": "559999999999",
    "document": "00000000000",
    "email": "joao@emailficticio.com",
    "is_group": false,
    "created_at": "2024-01-01T10:00:00.000Z",
    "updated_at": "2025-07-21T17:54:16.843Z",
    "extra_info": [
      {
        "id": 1,
        "name": "idade",
        "value": "30"
      },
      {
        "id": 2,
        "name": "cidade",
        "value": "São Paulo"
      }
    ]
  },
  "context": {
    "custom_1": "valor1",
    "custom_2": "valor2",
    "custom_3": "valor3"
  }
}

Exemplo - Resposta a Quick Reply

Quando o usuário clica em um botão de Quick Reply, o campo postback_text contém o valor configurado no botão.

{
  "event_id": "l70j4k50-ui4r-i7t0-q372-kk2211kk6666",
  "type": "message",
  "message": {
    "id": "00wamid.HBgMNUMyMDAwMDAwMDAwFQIAEhgUAAAAAAAABBBBCCCCDDDDEEEEFFFF000011112223",
    "from": "559999999999",
    "to": "5511999999999",
    "from_me": false,
    "from_bot": false,
    "user_id": null,
    "type": "text",
    "text": "Suporte Técnico",
    "postback_text": "support",
    "file": null,
    "datetime": "2025-07-21T14:54:36.487-03:00"
  },
  "ticket": {
    "id": 12345,
    "uuid": "abcd1234-abcd-1234-abcd-1234567890ab",
    "tracking_id": 987654,
    "campaign_id": 10,
    "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "cost_center_id": 1,
    "status": "pending",
    "user_id": null,
    "contact_id": 54321,
    "queue_id": 5,
    "transfer_queue_id": 2,
    "whatsapp_id": 3,
    "integration_id": 1,
    "from_me": false
  },
  "whatsapp": {
    "id": 3,
    "name": "Empresa Fictícia Tecnologia Ltda",
    "number": "5511999999999"
  },
  "contact": {
    "id": 54321,
    "name": "João da Silva",
    "number": "559999999999",
    "document": "00000000000",
    "email": "joao@emailficticio.com",
    "is_group": false,
    "created_at": "2024-01-01T10:00:00.000Z",
    "updated_at": "2025-07-21T17:54:16.843Z",
    "extra_info": [
      {
        "id": 1,
        "name": "idade",
        "value": "30"
      }
    ]
  },
  "context": {
    "custom_1": "valor1"
  }
}