Nastavení emailových notifikací přes API

Přehled

Přes API je možné nastavit různé varianty emailových notifikací podle časových událostí souvisejících s podepisováním dokumentů. Pro konfiguraci notifikací je třeba zaslat JSON, který bude obsahovat specifikované parametry.

JSON 

Níže je uveden příklad JSON pro nastavení emailových notifikací:

{
  "email_notifications": [
    {
      "type": "before_sign_expiration",
      "recipients": ["test@signi.com", "test2@signi.com"],
      "days": 1
    }
  ]
}

Popis parametrů

• type: Určuje typ notifikace, viz dostupné varianty níže.
• recipients: Pole s emailovými adresami, na které se má notifikace zaslat. Můžete přidat jednu nebo více emailových adres podle potřeby.
• days: Počet dní, který určuje, kdy se má notifikace zaslat ve vztahu k dané události.

Varianty notifikací

Pro parametr type jsou dostupné následující možnosti:

1. before_sign_expiration – Počet dní před vypršením platnosti dokumentu. Použijte parametr days pro určení, kolik dní před expirací má být notifikace zaslána. Například "days": 1 znamená zaslání notifikace jeden den před expirací.

2. after_send – Počet dní po odeslání dokumentu. Nastavení "days": 1 bude znamenat, že notifikace bude zaslána jeden den po odeslání dokumentu.

Ukázkový JSON pro after_send

Pokud chcete nastavit notifikaci pro odeslaný dokument, JSON bude vypadat následovně:

{
  "email_notifications": [
    {
      "type": "after_send",
      "recipients": ["test@signi.com"],
      "days": 3
    }
  ]
}

V tomto příkladu bude notifikace odeslána na adresu test@signi.com tři dny po odeslání dokumentu.

Omezení

V současnosti nejsou žádná omezení ohledně počtu emailových adres nebo frekvence zasílání notifikací.