プレビュー版
PocketSign Link v2 は現在プレビュー版です。正式提供までに仕様が変更される可能性があります。
ウェブフック設定
サービスウェブフックは PocketSign Platform から設定します。ウェブフックはサービスごとに 1 つ設定できます。
設定項目
| 項目 | 必須 | 説明 |
|---|---|---|
| URL | はい | KLONEvent の送信先エンドポイント。HTTPS である必要があります |
| イベント種別 | いいえ | 受信するイベントの種別。未指定の場合はすべてのイベントを受信します |
| 有効 / 無効 | はい | ウェブフックの有効状態 |
イベント種別のフィルタリング
ウェブフックに受信するイベント種別を指定することで、必要なイベントのみを受信できます。
- イベント種別を指定しない場合: すべてのイベントを受信します
- イベント種別を指定した場合: 指定したイベントのみ受信します
指定可能なイベント種別の一覧は KLONEvent 仕様を参照してください。
自動無効化
連続して配信に失敗した場合、サーキットブレーカーによりウェブフックが自動的に無効化されることがあります。詳細はエンドポイント仕様を参照してください。
自動無効化されたウェブフックは、PocketSign Platform から手動で再有効化してください。再有効化すると連続失敗回数がリセットされます。
関連ページ
- エンドポイントの実装要件は エンドポイント仕様
- 受信可能なイベントは KLONEvent 仕様