Webhook事件

Webhook 回调消息说明

回调地址需要登录eSignGlobal进入設置-集成-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 回调消息说明
事件列表