Webhook Events

Webhook Callback Description

You need to log in to eSignGlobal, navigate to Settings → Integrations → Webhook, and configure the callback address on the editing page.

 

  • When the HTTP status code returned to eSignGlobal is between 200 and 299, the notification is considered successful. Otherwise, eSignGlobal treats the notification as failed.

 

  • Retry Mechanism:

If a notification fails, the eSignGlobal notification service will retry up to 16 times. Depending on the module, one of the following two retry mechanisms may be used. If a retry attempt is successful, the notification process stops immediately.

Times

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

Time Interval

10s

30s

1m

2m

3m

4m

5m

6m

7m

8m

9m

10m

20m

30m

1h

2h

 

  • To prevent repeated notifications due to JSON parsing errors in the eSignGlobal notification service, ensure that the returned JSON data does not contain special characters such as spaces or backslashes. We recommend returning {"code":"200","msg":"success"} directly upon successful receipt of the data.

 

  • To ensure the timeliness and reliability of callback notifications, developers should respond to the eSignGlobal notification service with an HTTP status code 200 within 5 seconds of receiving the callback.

 

  • If your application cannot complete the callback-related business processing within 5 seconds, use asynchronous processing for any subsequent business logic.

 

Event List

Module

Action

Events

Description

Documents

ENVELOPE_START

Envelope Start

After the envelope is started.

ENVELOPE_SIGNER_SIGNED

Envelope Signer Signed

After the envelope is started, any signer completes the signing.

ENVELOPE_ALL_SIGNER_SIGNED

Envelope All Signer Signed

After the envelope is started, and all signer complete the signing.

ENVELOPE_FINISH

Envelope Finish

After envelope ends.

ENVELOPE_CANCEL

Envelope Cancel

After the envelope is started, and the sender canceled the envelope.

ENVELOPE_EXPIRED

Envelope Expired

After the envelope is started, and the envelope exceeds the expiration date.

Webhook Callback Description
Event List