Plataforma do Messenger

Referência sobre webhooks de messaging_postbacks

Este documento explica a carga JSON que o servidor de webhooks receberá quando um evento de webhook de postback de mensagem for disparado. Esse tipo de evento é disparado quando uma pessoa clica em um botão de postback, botão Começar ou item no menu persistente.

Exemplo de notificação

O exemplo a seguir mostra a carga JSON que será enviada ao seu servidor de webhooks.

{
  "field": "messaging_postbacks",
  "value": {
    "sender": {
      "user_ref": "USER-REF-ID"
    },
    "recipient": {
      "id": "PAGE-ID"
    },
    "timestamp": "1527459824",
    "postback": {
      "mid": "m_MESSAGE-ID",
      "title": "TITLE-FOR-THE-CTA",
      "payload": "USER-DEFINED-PAYLOAD",
      "referral": {
        "ref": "USER-DEFINED-REFERRAL-PARAM",
        "source": "SHORT-URL",
        "type": "OPEN_THREAD"
      }
    }
  }
}

Propriedades JSON

Todas as propriedades JSON em uma notificação de webhook são strings.

PropriedadeDescrição

postback.mid

O ID da mensagem.

postback.payload

As informações definidas no parâmetro payload da CTA. Elas aparecem somente na notificação do webhook do app que enviou a mensagem.

postback.referral

As informações sobre a ação realizada para entrar na conversa.

Em relação à propriedade referral, as informações aparecem na notificação de webhook apenas quando uma pessoa inicia a conversa usando uma destas opções para clicar em uma CTA (como um botão Começar):

  • Um plugin de bate-papo
  • Um link m.me
  • Um anúncio de clique para o Messenger
  • Um QR code para o Messenger
  • Uma tela de boas-vindas

postback.referral.ref

Os dados arbitrários originalmente passados no parâmetro ref adicionado ao link m.me. Só há compatibilidade com caracteres alfanuméricos, bem como -, _ e =.

postback.referral.source

A URL da referência. Para links m.me, o valor de origem é “SHORTLINK”. Para referências em anúncios de conversa do Messenger, o valor de origem é "ADS".

postback.referral.type

O identificador da referência. Para a referência de links m.me, o valor será sempre "OPEN_THREAD".

postback.title

O título da chamada para ação (CTA, pelas iniciais em inglês) em que a pessoa clicou.

recipient.id

O ID da Página do Facebook.

sender.user_ref

O ID de referência à pessoa que enviou uma mensagem por meio de uma ação (como clicar no botão Começar, no plugin de bate-papo ou em um item do menu persistente).

timestamp

O registro de data e hora UNIX de quando a notificação de webhook foi enviada ao servidor.

Veja também

Documentação adicional para desenvolvedores sobre os conceitos mencionados neste guia.