venuraju | Posts: 9

All callback events and their documentation

0 votes

Hi,

Can I get a list of all webhook callback events, WITH their meaning for each?

Thanks,

Venu


Duo_Liang | Posts: 3776

Reply to: All callback events and their documentation

1 votes

Hi Venu,

 

Thanks for your post! And sure, please refer to the "Setting up Callback Notifications" guide.

 

Duo


venuraju | Posts: 9

Reply to: All callback events and their documentation

0 votes

Hi Duo,

Follow-up question:
If I have signer and a co-signer, signing one after the other, which event gets triggered after the first signer completes signing? In other words, how do I identify that one signer has completed signing, and now it is co-signer's turn?

Thanks,

-Venu


Duo_Liang | Posts: 3776

Reply to:

0 votes

Hi Venu,

 

Is this an (1) in-person signing (package sender, signer, co-signer sign in the same device), (2) embedding signing (embed the signing ceremony into an iFrame and presents as part of your application) or (3) remote signing scenario (delivers signing links by out-of-the-box notification email), or a hybrid flow?

 

If it's an embedding signing scenario, you can either:

#1 set up a callback listener > register "SIGNER_COMPLETE" event > identify package and signer by the "packageId" and "sessionUser" attributes in payload

#2 set up a javascript notifier > register "ESL:MESSAGE:STARTED:SIGNER_COMPLETE" event

 

Duo


venuraju | Posts: 9

Reply to: All callback events and their documentation

0 votes

Hi Duo,

We are planning for two different flows:
1) Hybrid flow: Signer, co-signer, sender, in that order: First signer will sign in an embedded flow. Co-signer will sign through an email link. Once these two are complete, (me as a) sender will sign last.

2) All remote:  Signer, co-signer, sender, in that order: Signer will get email and complete signing. Then co-signer will get an email to complete the signing. And finally, the sender will sign.

In both flows, we would want to know the status of the package at any given point of time. For example, if the package is waiting for co-signer for more than a day, we would want to initiate a follow-up call/email.

Does package (packageId) contain one "sessionUser" for each signer? In the webhook event payload, I do see these attributes. How do we map these attributes back to signer, co-signer or sender?

Thanks,

-Venu

 


Duo_Liang | Posts: 3776

Reply to:

0 votes

"sessionUesr" refers to the signer ID or custom ID (.WithCustomId() in Java SDK modelling).

For a hybrid flow, you may also interested in the "Notify Signer" feature, you can turn off the default email.activate template, and programmatically trigger email.notify instead, as this guide suggested.

For a remote flow, you could set up "Signing orders" to specify the signing flow.

To update package status in bulk, I would suggest to Retrieve a list of Packages within a time range in order to save outbound API numbers.

 

Duo


venuraju | Posts: 9

Reply to: All callback events and their documentation

0 votes

Hi Duo,

Thanks for all the details. Will take a look.

-Venu


Hello! Looks like you're enjoying the discussion, but haven't signed up for an account.

When you create an account, we remember exactly what you've read, so you always come right back where you left off