Setting up email alerts via API

Overview

Through the API, it is possible to set up different variations of email notifications based on time events related to document signing. To configure notifications, you need to send a JSON containing the specified parameters.

JSON

Below is an example JSON for setting up email notifications:

{

  "email_notifications": [

    {

      "type": "before_sign_expiration",

      "recipients": [ "test@signi.com", "test2@signi.com"],

      "days": 1

    }

  ]

}

Parameter description

type: Specifies the type of notification, see available options below.

recipients: field with email addresses to which the notification should be sent. You can add one or more email addresses as needed.

days: number of days, which specifies when the notification should be sent in relation to the event.

Variants of notifications

The following options are available for the type parameter:

before_sign_expiration - The number of days before the document expires. Use the days parameter to specify how many days before expiration the notification should be sent. For example, "days": 1 means sending the notification one day before expiration.

after_send - The number of days after the document was sent. Setting "days": 1 will mean that the notification will be sent one day after the document is sent.

Sample JSON for after_send

If you want to set a notification for a sent document, the JSON will look like this:

{

  "email_notifications": [

    {

      "type": "after_send",

      "recipients": [ "test@signi.com" ],

      "days": 3

    }

  ]

}

In this example, the notification will be sent to test@signi.com three days after the document is sent.

Restrictions

Currently, there are no restrictions on the number of email addresses or the frequency of sending notifications.