Steps

Steps

This section describes the steps of the signature workflow:

• Which participants participate in each step. 
• Which communication entries are sent.

A step is a JSON array, containing JSON objects. Each object corresponds to one step of a sequential workflow. Only once a specific step is completed, the next step is started. Each entry of the array is a JSON object. Table 1 describes the step parameters.

Table 1: Step Parameters

Steps - Communication

This section describes the set of communication messages (SMS/emails) to be sent to different workflow participants. Each communication is a JSON object. Table 2 describes the communication parameters.

Table 2: Communication Parameters

Steps - Communication Entry

Table 3 describes the communication entry parameters.

Table 3: Communication Entry Parameters

Steps - Communication Entry - Email

Table 4 describes the email parameters.

Table 6: Email Parameters

Steps - Communication Entry - SMS

Table 5 describes the SMS parameters.

Table 5: SMS Parameters

Steps - Communication Entry - Escape Sequences

Table 6 describes escape sequences for communication entries.

Table 6: Escape Sequences

Sample Call

"steps": [
        {
            "communication": {
                "start": [
                    {
                        "participantId": "customer1",
                        "type": "email",
                        "email": "example@easysend.io",
                        "subject": "Documents to sign for {{name}}",
                        "body": "hi customer: {{name}}, here is your link: {{link}}"
                    },
                    {
                        "participantId": "agent",
                        "type": "email",
                        "email": "example@easysend.io",
                        "subject": "Documents to sign for {{name}}",
                        "body": "hi agent: {{name}}, here is your link: {{link}}"
                    }
                ],
                "finish": [
                    {
                        "participantId": "customer1",
                        "type": "email",
                        "email": "example@easysend.io",
                        "subject": "Done",
                        "body": "hi {{name}}, Thanks for submitting!"
                    }
                ]

Steps - Auto Reminder

Table 7 describes the auto reminder parameters.

Table 7: Auto Reminder

Steps - Auto Reminder - whenToSend

Table 8 describes the whenToSend parameter.

Table 8: whenToSend

Steps - Auto Reminder - whenToSend - daysAndTime

Table 9 describes the daysAndTime parameters.

Table 9: daysAndTime

Steps - Auto Reminder - whenToSend - numOfMinutes

Table 10 describes the numOfMinutes parameter.

Table 10: numOfMinutes

Sample Call

"autoReminders": [
                    {
                        "participantId": "customer1",
                        "type": "email",
                        "countdownTrigger": "linkSent",
                        "subject": "A kind reminder for {{name}}",
                        "body": "hi customer: {{name}}, here is your link reminder: {{link}}",
                        "whenToSend": {
                            "type": "numOfMinutes",
                            "minutes": 1
                        },
                        "maxNumOfSends": 1
                    },
                    {
                        "participantId": "customer1",
                        "type": "email",
                        "countdownTrigger": "lastOpened",
                        "subject": "Another kind reminder for {{name}}",
                        "body": "hi customer: {{name}}, here is your link reminder: {{link}}",
                        "whenToSend": {
                            "type": "daysAndTime",
                            "days": 2,
                            "time": "10:00"
                        },
                        "maxNumOfSends": 1
                    }
                ]

Steps - authProvider

Table 11 describes the authProvider parameters.

Table 11: authProvider

Sample Call

"authProvider": {
               "type": "standardOTPAuthProvider",
               "isTwoFactor": true,
               "otpSendMethod": "email",
               "skipNotListedParticipants": false,
               "skipOtpInDev": false,
               "participantsOtp": [
                   {
                       "participantId": "singerOne",
                       "phone": "0544664034",
                       "email": "r.shoshani@easysend.io"
                   },
                   {
                       "participantId": "singerTwo",
                       "phone": "0544664034",
                       "email": "ronshosh@gmail.com"
                   },
                   {
                       "participantId": "agent",
                       "phone": "0544664034",
                       "email": "ronshosh@gmail.com"
                   }
               ]
           }