Webhook事件

Webhook 回調消息說明

回調地址需要登錄eSignGlobal進入Settings-Intergrations-Webhook 的編輯頁面配置。

返回給 eSignGlobal 的 HTTP 狀態碼介於200~ 299之間,eSignGlobal認為通知成功,否則 eSignGloabal 認為通知失敗

  • 通知失敗後,eSignGlobal通知服務將會進行最多16次重試通知。 重試機制如下:

(不同的模塊可能走以下兩種不同的重試機製,若中間重試通知成功,則中斷不再繼續重試):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 回調消息說明
事件列表