E-mail notifications

Modified on Tue, 15 Sep at 11:55 AM

Besides webhooks (messages for your system), Signi can also send e-mail notifications to signers — alerts tied to time-based events of the document. They are configured when creating the document using the email_notifications field.

Notification types

  • after_send — reminder: a given number of days after the document is created, it resends the request to sign.
  • before_sign_expiration — an alert a given number of days before signing expiration (the document was not signed in time).

Example

Reminder to counterparties after 3 days + an alert to everyone one day before expiration:

{
    "people": [
        { "is_proposer": true, "email": "vas@email.cz", "contract_role": "sign",
          "positions": [ { "x": 50, "y": 20, "page": 0 } ] },
        { "is_proposer": false, "email": "josef@email.cz", "contract_role": "sign",
          "first_name": "Josef", "last_name": "Dvořák", "person_type": "nature",
          "positions": [ { "x": 20, "y": 80, "page": 0 } ] },
        { "is_proposer": false, "email": "jana@email.cz", "contract_role": "sign",
          "first_name": "Jana", "last_name": "Novotná", "person_type": "nature",
          "positions": [ { "x": 70, "y": 80, "page": 0 } ] }
    ],
    "email_notifications": [
        {
            "type": "after_send",
            "recipients": ["josef@email.cz", "jana@email.cz"],
            "days": 3
        },
        {
            "type": "before_sign_expiration",
            "recipients": ["vas@email.cz", "josef@email.cz", "jana@email.cz"],
            "days": 1
        }
    ],
    "file": "uploaded_file_key"
}
  • type — notification type (see above)
  • recipients — who the alert is sent to
  • days — number of days (after creation for after_send, before expiration for before_sign_expiration)

Good to know

  • Recipients must be signers of the document. An address that is not on the document is skipped — it will not receive the notification.
  • Anyone who has already completed their signature will not receive the alert. And once the document is completed (or rejected or expired), nothing more is sent.
  • If you don't send email_notifications at all, Signi automatically sets an alert one day before expiration for all signers.

The response when creating the document is the same as usual (contract_id, state, notifications with links) — the e-mail notification settings are not shown in it in any way.

Where to go next

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article