Help > Forum > ウェブサイトの統合 > ウェブフックの使用

ウェブフックの使用

Webhook を使用して、フォーラムで発生したイベントについて通知を受け取ることができます。

イベントが発生した場合 (たとえば、新しいユーザーがフォーラムにアカウントを作成したときなど)、Web サイトツールボックスは Event オブジェクトを作成します。このオブジェクトには、イベントのタイプとそのイベントに関連付けられたデータなど、発生した処理に関するすべての関連情報が含まれます。次に、HTTP POST リクエストを介して、イベントオブジェクトを JSON としてウェブフック URL に送信します。

Webhook はフォーラム API と組み合わせるとうまく機能します。たとえば、Webhook は、新しいユーザーがフォーラムにサインアップしたときにアプリケーションに通知し、API を使用してそのユーザーのフォーラムアカウントに変更を加えることができます。

この機能を使用するには、フォーラム成長プランまたはプロプランが必要です。

次のイベントが現在サポートされています:user.created、user.approved、user.aproved、user.email.verified、user.payment.recied、user.payment.recied、user.paid_subscription.started、ユーザー.paid_subscription.ended、トピック.作成、post.deleted、post.proved、post.updated、post.deleted、created、およびmessage.created。新しいWebhookイベントが必要な場合は、お知らせください


Webhook の設定を構成する

  1. Web サイト Toolbox アカウントにログインします。
  2. をクリックします。 統合する リンク。
  3. をクリックします。 Webhook リンク。
  4. Webhook URL を横にあるテキストボックスに入力します。 Webhook オプション。

ウェブフックへの応答

Webhook の受信を確認するために、エンドポイントは 2xx HTTP ステータスコードを返す必要があります。リクエストヘッダーまたはリクエスト本文で返されたその他の情報は無視されます。この範囲外のレスポンスコード (3xx コードを含む) は、Webhook を受信しなかったことを示します。これは、URL リダイレクトまたは「変更されていない」応答が失敗として扱われることを意味します。

何らかの理由で Webhook が正常に受信されなかった場合、最大 3 日間は 1 時間に 1 回、ウェブフックを送信しようとします。


イベントの例

{
  "api_version": "1",
  "data": {
    "object": {
      "signature": "Thanks, John.",
      "name": "John Doe",
      "allowEmails": false,
      "lastPostTimestamp": 0,
      "userGroups": [7440, 2452, 52423],
      "userTitle": "Power User",
      "reputation": 423,
      "username": "john",
      "postCount": 32,
      "userId": 181855,
      "lastVisitTimestamp": 1322811119,
      "instantMessagingType": "",
      "instantMessagingId": "",
      "object": "User",
      "invisible": false,
      "email": "johnDoe@gmail.com",
      "avatarUrl": "https://test.com/images/avatar.png",
      "joinDateTimestamp": 1322811119,
      "enableMessages": true
    }
  },
  "object": "event",
  "id": 1534,
  "type": "user.created",
  "mode": "live"
}

Webhook イベントとレスポンスの表示

以下の手順に従って、Webhook に送信されたイベントと Webhook から受信した応答を表示できます。

  1. Web サイト Toolbox アカウントにログインします。
  2. をクリックします。 コンテンツ リンク。
  3. 内にある コンテンツ メニューで、 Webhook ログ リンク。(存在しない場合 Webhook ログ リンク、つまり、ウェブフックの URL が ウェブフック設定 まだ。)


If you still need help, please contact us.