概要

イベントウェブフックは、ポケットサインアプリまたはAPIサーバー上で発生したサービスに関連する各種イベント(PSLinkEventと言います)を、サービスのバックエンドに通知する仕組みです。

これにより、サービスはポケットサインから非同期で以下のような情報を受け取ることができます。

• ユーザーがポケットサインアプリ上でサービスをサブスクライブした
• ユーザーがポケットサインアプリ上でサービスのサブスクライブを解除した

注記

受け取ることができるイベントの種類は、今後拡充される予定です。

PSLinkEventの受信

PSLinkEventは、発生したイベントの種類やそのイベントに関する情報を、規定のスキーマでペイロード部分に含んでいるJWT形式として表現されます。

ポケットサインからイベント通知(PSLinkEvent)を受け取るには、規定の仕様に従ったウェブフックエンドポイントをサービスのバックエンドサーバーに実装する必要があります。

詳細はウェブフックエンドポイント仕様をご参照ください。

ウェブフックエンドポイントの登録

サービスのウェブフックエンドポイントをポケットサインに登録し、PSLinkEventの通知を受け取る方法は、Webhook 設定を参照してください。