shivgonarkar | Posts: 22

Notify signer1 when signer2 sign an agreement

0 votes

We are integrating with Onespan using Rest API.

We have three types of Roles. Broker , customer and Business.

Broker first sign an agreement(using esign), followed by customer and then Business people sign an agreement.

Now we have requirement where we want to notify Broker(Signer1) when Customer(Signer2) signs and agreement via email.

Just wanted to know what is the best way to do this with Onespan.

One thing I know is we can use the webhook call , But not sure if we can use any onespan API to send an email to broker when we receive the webhook call.


Approved Answer
Duo_Liang | Posts: 3776

Reply to: Notify signer1 when signer2 sign an agreement

0 votes

Hi shivgonarkar,

 

There are two APIs to send notification to signers, one of them allows to override signer message ($PACKAGE_MESSAGE;) on the fly:

POST /api/packages/{packageId}/notifications

Example Payload:
{ "email": "[email protected]", "message": "Customer has completed signing!" }

 

Let me know if this helps.

Duo


shivgonarkar | Posts: 22

Reply to: Notify signer1 when signer2 sign an agreement

0 votes

Thanks Duo, If I go with above approach , If I call the notifications API , Which email template it will pick up out of the list mentioned here https://community.onespan.com/documentation/onespan-sign/guides/sender-guides/user/list-email-templates? 


Duo_Liang | Posts: 3776

Reply to: Notify signer1 when signer2 sign an agreement

0 votes

Hi shivgonarkar,

 

Template "email.notify" will be picked up in this case.

 

Duo


shivgonarkar | Posts: 22

Reply to: Notify signer1 when signer2 sign an agreement

0 votes

Thank you Duo.

Just wanted to check if this email template "email.notify" only gets used when we call POST /api/packages/{packageId}/notifications.

When we enable this template at account level, We want to make sure this template only get used when we call /api/packages/{packageId}/notifications. API.

Hope they don't get used on some other events like "initial email invitation to sign package gets bounce" etc.


shivgonarkar | Posts: 22

Reply to: Notify signer1 when signer2 sign an agreement

0 votes

Hi Duo ,

 

could you please let me know on my last comment


shivgonarkar | Posts: 22

Reply to: Notify signer1 when signer2 sign an agreement

0 votes

Hi Duo ,

 

Awaiting your reply.

We are planning to change the template "email.notify" to suit our requirement. We will use this to send email to Broker(Signer1) when Customer(Signer2) signs an agreement.

I have some doubts regarding what return in documentation against "email.notify" template.

 

" email.notify

This template re-sends an email invitation to review or sign a package after the initial invitation bounced. The re-sending happens once the bounce occurs, and does not depend on any timeline (such as an elapsed period of time after the initial invitation).

What follows is the default email.notify template used by OneSpan Sign. "

 

Let say if email gets bounce for Signer1(Broker) , will email gets automatically sent to Signer1 again and use the email.notify template ? It may cause issue for us.

We want to make sure email.notify template only gets used when we call POST /api/packages/{packageId}/notifications API

 

 


shivgonarkar | Posts: 22

Reply to: Notify signer1 when signer2 sign an agreement

0 votes

Got this error when I tried solution approach mentioned above. Any other approach I can try

 

{

    "messageKey": "error.validation.notifySigner.outOfOrder",

    "code": 400,

    "message": "Unable to notify the signer until it is their turn to participate.",

    "name": "Validation Error"

}


Duo_Liang | Posts: 3776

Reply to: Notify signer1 when signer2 sign an agreement

0 votes

Hi shivgonarkar,

 

I was on PTO last week.

For your questions:
(1)In documentation, email.notify was described as "initial email invitation to sign package gets bounce", but I think this could be a doc issue and this email template is literally only triggered when you invoked signer notify API.

(2)for the 400 "signer out of order error", can I have the package ID? From the description, it sounds like you have turned on the signing order? I need to look closer into your package to further analyze the issue.

 

Duo


shivgonarkar | Posts: 22

Reply to: Notify signer1 when signer2 sign an agreement

0 votes

I tested this with other package , I did not get "signer out of order error" and it sent email properly.

Sorry I tested some wrong scenario because of which I was getting this error.

And Thanks for clarification about the email.notify template. I will proceed to use this.

 


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