Webhook を使用して、フォーラムで発生したイベントの通知を受け取りましょう。
イベントが発生すると (たとえば、新しいユーザーがフォーラムにアカウントを作成したときなど)、Website Toolbox はイベントオブジェクトを作成します。このオブジェクトには、イベントのタイプやそのイベントに関連するデータなど、発生したことに関するすべての関連情報が含まれています。次に、イベントオブジェクトを JSON として HTTP POST リクエスト経由でウェブフック URL に送信します。
ウェブフックはフォーラム API と組み合わせるとうまく機能します。たとえば、新しいユーザーがフォーラムにサインアップしたときにウェブフックがアプリケーションに通知し、API を使用してそのユーザーのフォーラムアカウントを変更することができます。
この機能を使用するには、フォーラム Growth プランまたは Pro プランが必要です。
ウェブフック設定の構成
- ウェブサイトツールボックスアカウントにログインします。
- 「統合」リンクをクリックします。
- Webhook リンクをクリックします。
- 「Webhook を追加」ボタンをクリックします。
- Webhook URL を入力し、受信したいイベントを選択します。
- 「保存」をクリックします。
複数の Webhook を作成して、異なる URL にイベントを送信できます。各 Webhook は、異なるタイプのイベントを受信するように設定できます。
ウェブフックへの対応
Webhook イベントを受信するためのサンプルコードをご覧ください。
Webhook の受信を確認するには、エンドポイントが 2xx HTTP ステータスコードを返す必要があります。リクエストヘッダーまたはリクエスト本文で返されるその他の情報は無視されます。この範囲外のレスポンスコード (3xx コードを含む) はすべて、Webhook を受信しなかったことを示します。つまり、URL リダイレクトや「未変更」の応答は失敗として扱われます。
何らかの理由でWebhookが正常に受信されない場合、最大3日間、1時間に1回Webhookの送信を試みます。
イベントの例
{
「api_version」:「1",
「データ」: {「オブジェクト」: {
「署名」:
「ありがとう、ジョン。」、
「名前」：「John Doe」、
「AllowEmail」：false、
「最終投稿タイムスタンプ」：0、
「ユーザーグループ」：[7440、2452、52423]、
「ユーザータイトル」：「パワーユーザー」、
「評判」：423、
「ユーザー名」：「john」、
「投稿数」：32、
「ユーザーID」：181855、
「最終訪問タイムスタンプ」: 1322811119,
「インスタントメッセージタイプ」:「」,「インスタントメッセージ ID」:
「」,「オブジェクト」:「ユーザー」,
「非表示」: false,「電子メール」: "johnDoe@gmail.com
「,
「アバター URL」: "https://test.com/images/avatar.png「,
「JoinDateTimestamp」: 1322811119,
「EnableMessages」: true
}},
「オブジェクト」:
「イベント」,「id」: 1534,
「タイプ」:「user.created」,
「モード」:「live」
}
ウェブフックのイベントとレスポンスを表示する
ウェブフックに送信されたイベントとウェブフックから受信したレスポンスを確認するには、以下の手順に従ってください。
- ウェブサイト・ツールボックス・アカウントにログインします。
- 「統合」リンクをクリックします。
- Webhook リンクをクリックします。
- 表示したいWebhookのイベント数をクリックします。