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