Webhookイベントのリファレンス

Webhookイベントは、メッセージの送信など、さまざまなインタラクションやイベントが発生した際にMessengerプラットフォームがボットに通知を送信する仕組みです。Webhookイベントは、Messengerプラットフォームにより、POSTリクエストとしてWebhookに送信されます。

注: 自分のビジネスのすべてのメッセージアプリで、メッセージWebhooksをサブスクリプション登録する必要があります。

Webhookイベントのリスト

以下は、MessengerプラットフォームからWebhookに送信できるイベントのリストです。

注: 各Webhookで入手できるすべての情報を受け取るため、最新のAPIバージョンを使うことをおすすめします。

Webhookイベント	説明
`messages`	メッセージ受信イベントをフォローします
`messaging_account_linking`	アカウントのリンクイベントをフォローします
`messaging_checkout_updates` (ベータ)	チェックアウト更新イベントをフォローします
`message_deliveries`	メッセージ配信イベントをフォローします
`message_echoes`	メッセージエコーイベントをフォローします
`messaging_game_plays`	インスタントゲームイベントをフォローします
`messaging_handovers` (ベータ)	ハンドオーバープロトコルイベントをフォローします
`messaging_optins`	プラグインのオプトインイベントをフォローします
`messaging_payments` (ベータ)	支払いイベントをフォローします
`messaging_policy_enforcement`	ポリシー順守のためのイベントをフォローします。
`messaging_postbacks`	ポストバック受信イベントをフォローします
`messaging_pre_checkouts` (ベータ)	支払いチェックアウト前イベントをフォローします
`message_reads`	メッセージ読み取りイベントをフォローします
`messaging_referrals`	リファーラルイベントをフォローします
`standby` (ベータ)	ハンドオーバープロトコルスタンバイチャネルイベントをフォローします

イベントフォーマット

Messengerプラットフォームのコールバックはすべて共通のプロパティを持ち、ボット利用者の入力の処理や応答に必要な情報を提供します。各イベントには、以下のプロパティの他に、イベントの詳細を表す固有のプロパティがあります。

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

          ...
        }
      ]
    }
  ]
}

プロパティ

プロパティ	型	説明
`object`	文字列	値は`page`になります
`entry`	`entry`の配列	イベントデータを含む配列です

`entry`

プロパティ	型	説明
`id`	文字列	ページのページID
`time`	数値	更新の時刻(エポックタイム(ミリ秒))
`messaging`	配列<`messaging`>	`messaging`オブジェクトを1つ含む配列です。これは配列ですが、含まれるのは`messaging`オブジェクト1つのみであることに注意してください。

`entry.messaging`

プロパティ	型	説明
`sender.id`	文字列	送信ユーザーID
`recipient.id`	文字列	受信ユーザーID

詳しくはこちら

メッセージを処理する複数のアプリがある(例えば、1つのアプリが自動応答を処理し、もう1つのアプリがヒューマンエージェントへのエスカレーションを処理する)場合、1つのアプリから別のアプリにスレッドを渡すハンドオーバープロトコルを実装する必要があります。ハンドオーバープロトコル