Referência dos eventos de webhook

Os eventos de webhook são o método usado pela plataforma do Messenger para notificar seu bot da ocorrência de várias interações ou eventos, incluindo quando uma pessoa envia uma mensagem. Os eventos de webhook são enviados pela plataforma do Messenger como solicitações de POST para seu webhook.

Observação: é preciso assinar os webhooks de mensagem em todos os apps de mensagem da empresa.

Lista de eventos de webhook

Veja abaixo uma lista dos eventos que podem ser enviados pela plataforma do Messenger ao seu webhook.

Observação: é recomendável usar a versão mais recente da API para receber todas as informações disponíveis para cada webhook.

Evento de webhookDescrição

messages

Assina os eventos de Mensagem recebida

messaging_account_linking

Assina os eventos de Vinculação de conta

messaging_checkout_updates (beta)

Assina os eventos de Atualização de finalização da compra

message_deliveries

Assina os eventos de Mensagem entregue

message_echoes

Assina os eventos de Eco de mensagem

messaging_game_plays

Assina os eventos de Jogos instantâneos

messaging_handovers (beta)

Assina eventos de Protocolos de entrega

messaging_optins

Assina os eventos de Plugin de chamada

messaging_payments (beta)

Assina os eventos de Pagamento

messaging_policy_enforcement

Assina os eventos de Imposição de políticas

messaging_postbacks

Assina os eventos de Postback recebido

messaging_pre_checkouts (beta)

Assina os eventos de finalização prévia de pagamentos

message_reads

Assina os eventos de Mensagem lida

messaging_referrals

Assina os eventos de Referência

standby (beta)

Assina eventos de canal de espera de protocolo de entrega

Formato do evento

Todos os retornos de chamada para a plataforma do Messenger têm um conjunto comum de propriedades que fornecem as informações necessárias para processar e responder às entradas das pessoas que usam seu bot. Além das propriedades mostradas abaixo, há um conjunto de propriedades específicas que detalha cada evento.

{
  "object":"page",
  "entry":[
    {
      "id":"<PAGE_ID>",
      "time":1458692752478,
      "messaging":[
        {
          "sender":{
            "id":"<PSID>"
          },
          "recipient":{
            "id":"<PAGE_ID>"
          },

          ...
        }
      ]
    }
  ]
}

Propriedades

Propriedade Tipo Descrição

object

String

O valor será page

entry

Matriz de entry

Matriz que contém dados do evento

entry

Propriedade Tipo Descrição

id

String

Identificação da Página

time

Número

Hora da atualização (horário em milissegundos)

messaging

Matriz<messaging>

Matriz que contém o objeto messaging. Embora seja uma matriz, ela contém apenas um objeto messaging.

entry.messaging

Propriedade Tipo Descrição

sender.id

String

Número de identificação do usuário remetente

recipient.id

String

Número de identificação do usuário destinatário

Saiba mais

Se você gerenciar as conversas usando mais de um app (por exemplo, um para respostas automáticas e outro para agente humano), será necessário implementar o protocolo de entrega para transferir a conversa entre eles. Protocolo de entrega