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

ウェブフックの使用

Webhookを使用して、フォーラムで発生したイベントに関する通知を受け取ります。

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

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

現在サポートされているイベントは次のとおりです。ユーザー作成、ユーザー.承認済み、ユーザー.アップデート済み、ユーザー.email.verified、ユーザー.payment.received、ユーザー.payment.started、ユーザー.paid_subscription.started、ユーザー.paid_subscription.ended、トピック .created、トピック .updated、削除、投稿 .created、投稿 .created、投稿 .updated、投稿 .deleted、投稿。 会話. 作成, メッセージ. 作成. お願い お知らせください 特定の新しいWebhookイベントが必要な場合。


Webhook 設定の構成

  1. ウェブサイトのツールボックスアカウントにログインします。
  2. 左側の [設定] リンクをクリックします。
  3. [ [設定] メニューで、 通知 リンクをクリックします。
  4. Webhook の URL を、 ウェブフック オプションを使用します。

Webhookへの応答

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. ウェブサイトのツールボックスアカウントにログインします。
  2. 左側の 将軍 リンクをクリックします。
  3. [ 将軍 メニューで、 ウェブフック リンクに追加されます ( ウェブフック リンクに含まれている場合は、Webhook URL が Web フック設定 を参照してください。)


If you still need help, please contact us.