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

ウェブフック設定

サービスウェブフックは PocketSign Platform から設定します。ウェブフックはサービスごとに 1 つ設定できます。

設定画面はサービス詳細の「Webhook」タブにあります。Webhook URL、有効状態、受信イベント、リソースイベント購読設定を同じ画面で確認できます。

サンプルサービスの Webhook 設定画面。Webhook URL、有効状態、受信イベント、リソースイベント購読設定、購読リソースの追加欄が表示されている

設定項目

項目必須説明
URLはいKLONEvent の送信先エンドポイント。HTTPS である必要があります
イベント種別いいえ受信するイベントの種別。未指定の場合はすべてのイベントを受信します
有効 / 無効はいウェブフックの有効状態

イベント種別のフィルタリング

ウェブフックに受信するイベント種別を指定することで、必要なイベントのみを受信できます。

  • イベント種別を指定しない場合: すべてのイベントを受信します
  • イベント種別を指定した場合: 指定したイベントのみ受信します

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

自動無効化

連続して配信に失敗した場合、サーキットブレーカーによりウェブフックが自動的に無効化されることがあります。詳細はエンドポイント仕様を参照してください。

自動無効化されたウェブフックは、PocketSign Platform から手動で再有効化してください。再有効化すると連続失敗回数がリセットされます。

関連ページ