メインコンテンツまでスキップ
プレビュー版
PocketSign Link v2 は現在プレビュー版です。正式提供までに仕様が変更される可能性があります。

サービスウェブフック

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

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

  • ユーザーがサービスをサブスクライブした / 解除した
  • ユーザーのリソース値が書き込まれた / 削除された / 算出リソースが変化した

KLONEvent の受信

KLONEvent は JWT 形式で表現されます。ペイロード部分には、イベントの種類や関連情報が規定のスキーマで含まれます。

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

詳細はエンドポイント仕様をご参照ください。

ウェブフックの設定

サービスのウェブフックは PocketSign Platform から設定します。設定項目の詳細はウェブフック設定を参照してください。

イベントの種類

受信可能なイベントの一覧は KLONEvent 仕様を参照してください。