開発者センター

Webhookイベント

Webhookコールバックメッセージの説明

コールバックアドレスはeSignGlobalにログインして入る必要があります設定-連携-Webhookの編集ページで設定します。

eSignGlobalに返されるHTTPステータスコードは200~299の間で、eSignGlobalは通知成功と見なします。そうでない場合、eSignGloabalは通知失敗

  • と見なします。通知失敗後、eSignGlobal通知サービスは最大16回のリトライ通知を行います。リトライメカニズムは以下のとおりです:

(異なるモジュールは以下の2つの異なるリトライメカニズムを使用する可能性があります。途中でリトライ通知が成功した場合、中断してリトライを継続しません):

image.png
  • eSignGlobal通知サービスがJSONデータの解析に失敗して繰り返し通知されるのを防ぐため、返されるJSONデータにスペース\/などの特殊文字が含まれていないことを確認してください。受信に成功した場合は、直接 {"code":"200","msg":"success"}
  • コールバック通知の即時性と信頼性を確保するため、開発者はコールバック通知を受信した後、5秒以内HTTPステータスコード(200)をeSignGlobal通知サービスに返してください。
  • 開発者が5秒以内にコールバック通知関連のビジネス処理を完了できない場合は、非同期方式で後続のビジネス処理を実行してください。

 

イベントリスト

モジュール

イベントタイプ Action

イベント名

イベント説明

Documents

ENVELOPE_START

Envelope Start

署名プロセス開始後

ENVELOPE_SIGNER_SIGNED

Envelope Signer Signed

署名プロセス開始後、いずれかの署名者が署名を完了

ENVELOPE_ALL_SIGNER_SIGNED

Envelope All Signer Signed

署名プロセス開始後、すべての署名者が署名を完了

ENVELOPE_FINISH

Envelope Finish

署名プロセスが終了

ENVELOPE_CANCEL

Envelope Cancel

署名プロセス開始後、起案者が署名プロセスを破棄

ENVELOPE_EXPIRED

Envelope Expired

署名プロセスの流動時間が有効期限を超過

Webhookコールバックメッセージの説明
イベントリスト