Callback Events

Callback Description

You need to log in to eSign.AI, navigate to Settings → Integrations → Apps, and configure the callback address on the editing page.

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

Retry Mechanism:

If a notification fails, the eSign.AI 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 eSign.AI 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 eSign.AI 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

Event Name	Event type action	Event Description	Event Scenario
ENVELOPE_UPDATE	ENVELOPE_START	Envelope Open Notification	After the envelope is started.
ENVELOPE_UPDATE	ENVELOPE_SIGNER_SIGNED	Signatory Signed Completion Notice	After the envelope is started, any signer completes the signing.
ENVELOPE_UPDATE	ENVELOPE_ALL_SIGNER_SIGNED	Completion notice signed by all signatories	After the envelope is started, and all signatories complete the signing.
ENVELOPE_UPDATE	ENVELOPE_FINISH	Envelope End Notice	After envelope ends.
ENVELOPE_UPDATE	ENVELOPE_CANCEL	Notice of Revocation of Envelope	After the envelope is started, and the sender canceled the envelope.
ENVELOPE_UPDATE	ENVELOPE_EXPIRED	Notice of Envelope Expiration	After the envelope is started, and the envelope exceeds the expiration date.
TEMPLATE	TEMPLATE_FILL_RESULT	Template filling result notification	Completion of template filling.