E-mail notifications (API)

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

Notification types

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

Example

Reminder to counterparties after 3 days + alert to everyone the 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 — the 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 won't receive the notification.
• Anyone who has already completed their signature won't get 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 the day before expiration for all signers.

The response when creating 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

• Webhooks — automatic reports of document status changes — messages for your system instead of e-mails
• Document lifecycle