メインコンテンツまでスキップ

概要

「お客様サービス側ユーザID の紐付け」や「ログインプロバイダの紐付け削除」などのイベントが発生すると、ソーシャルPLUS から、あらかじめ設定した Webhook URL に HTTP リクエストが送信されます。

Webhook URL の事前登録

現在、Webhook URL の登録は サポート窓口 よりお受けしております。 ご利用になりたい場合は『ソーシャルPLUS の Webhook 機能の利用希望』の旨をご連絡ください。

ご利用要件​

ご利用には 機能導入サーバ側の要件 を満たす必要があります。また、外部からの HTTP リクエストを受けられる設定であることを確認してください。

Web API を実行するサーバ（A）と Webhook の受信を行うサーバ（B）は同一でなくても構いません。

イベント処理は非同期化することを推奨します

ユーザ操作を起因とした Webhook イベントは、たくさんのユーザが操作することで連続して発生することがあります。HTTP リクエストの処理が後続のイベントの処理に遅延を与えないよう、イベント処理を非同期化することを推奨します。

ソーシャルPLUS の IP アドレスは開示していません

Webhook リクエストの送信元となるソーシャルPLUS の IP アドレスは開示していません。セキュリティの担保は IP アドレスによるアクセス制御ではなく署名の検証で実施してください。

用語の定義​

イベント​

  • Webhook による通知が行われるトリガーとなる処理のこと
  • 1 回の Webhook イベント通知では 1 つのイベント情報を送信します

イベントタイプ（type）​

ペイロード（payload）​

  • Webhook で送信されるリクエストボディ（データ）のこと
  • あらかじめ決定したフォーマット（JSON 形式）のデータを送信します

Webhook URL​

  • ソーシャルPLUS から送信する HTTP リクエストを、ご利用サービス側で受け取るための URL
  • イベントごとに異なる URL、またはすべてのイベントで同じ URL を指定可能です
    • イベントごとに異なる URL を指定する例
      • https://example.com/from_socialplus/map や https://example.com/from_socialplus?event_id=merge_user のように、貴社システム側のパスやクエリでイベントタイプごとにエンドポイントを分け、イベントを判断します
    • すべてのイベントで同じ URL を指定する例
      • https://example.com/from_socialplus といった 1 つのエンドポイントでイベントを受信します
      • ペイロード内のイベントタイプ情報でイベントを判断します
  • ソーシャルログイン時のコールバック URL とは異なり、ご利用ドメインの制限はありません
Webhook URL の事前登録

現在、Webhook URL の登録は サポート窓口 よりお受けしております。 ご利用になりたい場合は『ソーシャルPLUS の Webhook 機能の利用希望』の旨をご連絡ください。

ユーザーエージェント​

Webhook 送信元となるソーシャルPLUS 側のユーザーエージェントは以下の文字列となります。

SocialPLUS-Webhook/1.0
に最終更新