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

ウェブフックの使用

Webhookを使用して、フォーラムで発生したイベントを通知します。

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

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

現在サポートされているイベントは次のとおりです。ユーザー作成済み、ユーザー.承認済み、ユーザー.更新済み、ユーザー.削除済み、ユーザー.email.検証済み、ユーザー.ペイメント.受信済み、ユーザー.paid_サブスクリプション.開始済み、ユーザー.paid_サブスクリプション.終了、トピック作成済み、トピック.更新済み、トピック.削除済み、投稿.作成済み、投稿.承認、投稿.更新済み、投稿.削除済み、投稿.削除済み、投稿.削除済み、投稿.削除済み、投稿.削除済み、投稿.削除済み、投稿.削除済み、投稿.更新済み、投稿.削除済み、投稿.削除済み、投稿.削除済み、会話.作成され、メッセージ.作成されました。 お願い お知らせください 特定の新しいWebhookイベントが必要な場合は、


ウェブフックの設定を構成する

  1. Website Toolboxのアカウントにログインします。
  2. 画面右上の [設定] リンクをクリックします。
  3. [ [設定] ] メニューで、 通知 リンクをクリックします。
  4. ウェブフックの URL を、 ウェブフック オプションを使用します。

ウェブフックへの応答

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

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


イベントの例

{
  "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. Website Toolboxのアカウントにログインします。
  2. 画面右上の [コンテンツ] リンクをクリックします。
  3. [ [コンテンツ] ] メニューで、 ウェブフック リンクをクリックします。 (存在しない場合 ウェブフック リンクから参照できます。つまり、Webhook URL が ウェブフック設定 まだです。)


If you still need help, please contact us.