BOTCHAN EFOではコンバージョンデータの受け渡しにWebhookを利用することができます。BOTCHAN EFOでは、Secret Keyを用いたなりすまし防止対策を行ったSecure Webhookと、GETもしくはPOSTを単純にリクエストするWebhookの2種類のしくみがあります。

Secure Webhook

Secure WebhookではX-Efo-Signatureリクエストヘッダに入力値のダイジェスト値を付与して入力値を送信します。受け手のサーバー側では、BOTCHA管理画面にあるSecret Keyを元に、リクエストボディの入力値からダイジェスト値を算出し、リクエストヘッダのダイジェスト値と一致するかを比較して、リクエストの正当性を検証することができます。

bot secretについて

BOTCHAN EFOに関連付けられた一意のBot secretです。

BOTCHAN EFOからWebhookへのリクエストを認証する際に使用されます。

管理画面の**「ボット設定」「コンバージョン設定」**をクリックし、コピーしてパスワードと同様に扱ってください。

1.webhookのURL登録

管理画面の[**ボット設定] ＞[コンバージョン]をクリックします。「データ送信」を選択し、「Webhook設定」**をアクティブに設定し、該当のURLを「Webhook設定」の横の入力欄に入力します。

正しく情報が入力されていることを確認し、**「保存」**をクリックしてください。

<aside> 📌 Bot secretについて

BOTCHAN EFOに関連付けられた一意のBot secretです。

BOTCHAN EFOからWebhookへのリクエストを認証する際に使用されます。コピーしてパスワードと同様に扱ってください。

</aside>

2.webhookリクエストフォーマット

2.1　リクエストボディ

リクエストボディの例

{
    "type" : "send_cv",
    "time": 1526464819578,
    "source": {
        "botId": "5ea6c4a2ce7ce72474375ae2",
        "type": "user"
    },
    "messaging": {
        "sender": { "id" : "1587987709654KKssKnY0XNYPtgX"},
        "recipient": { "id" : "5ea6c4a2ce7ce72474375ae2"},
        "timestamp": 1526464819122,
        "message": [
            {
                id: 5afa840a41ecbb9debedf2bf,
                type: 'date',
                name: '生年月日',
                value: [ '1985/5/15' ]
            },
            {
                id: 5afa840f41ecbb9debedf2e1,
                type: 'date_period',
                name: '希望期間',
                value: [ '2018/5/14 ～ 2018/5/25' ]
            },
　　　　　　　 {
                id: 5afa841241ecbb9debedf301,
                type: 'radio',
                name: '趣味',
                value: [ 'スポーツ' ]
            }
        ]
    }
}

以下のプロパティはすべてのwebhookイベントオブジェクトに含まれます。