Sdílet prostřednictvím

SignatureAPI

Odesílání dokumentů pro podepisování, sledování jejich průběhu a rychlejší práce pomocí SignatureAPI, platformy pro elektronické podpisy vytvořené pro automatizaci. https://signatureapi.com/docs/integrations/power-automate/getting-started

Tento konektor je dostupný v následujících produktech a oblastech:

Service Class Regions
Copilot Studio Premium Všechny oblasti Power Automate s výjimkou následujících:
     – státní správa USA (GCC)
     – státní správa USA (GCC High)
     - China Cloud provozovaný společností 21Vianet
     - Ministerstvo obrany USA (DoD)
Logic Apps Standard Všechny oblasti Logic Apps s výjimkou následujících:
     – Oblasti Azure Government
     – Oblasti Azure China
     - Ministerstvo obrany USA (DoD)
Power Apps Premium Všechny oblasti Power Apps s výjimkou následujících:
     – státní správa USA (GCC)
     – státní správa USA (GCC High)
     - China Cloud provozovaný společností 21Vianet
     - Ministerstvo obrany USA (DoD)
Power Automate Premium Všechny oblasti Power Automate s výjimkou následujících:
     – státní správa USA (GCC)
     – státní správa USA (GCC High)
     - China Cloud provozovaný společností 21Vianet
     - Ministerstvo obrany USA (DoD)
Kontakt
Název Signature API, Inc.
URL https://signatureapi.com
Email support@signatureapi.com
Metadata konektoru
Vydavatel SignatureAPI
Internetová stránka https://signatureapi.com/power-automate
Zásady ochrany osobních údajů https://signatureapi.com/privacy
Kategorie Spolupráce; Produktivita

SignatureAPI

SignatureAPI je platforma elektronického podpisu vytvořená pro automatizaci.

Odesílat dokumenty pro podepisování a sledovat jejich průběh pomocí naší platformy pro elektronické podpisy pro Power Automate, která poskytuje různé akce a triggery, které vám pomůžou vytvářet jednoduché i složité pracovní postupy.

Elektronické podpisy vytvořené pomocí SignatureAPI jsou právně závazné a globálně přijímané, stejně jako tradiční rukopisné podpisy ve většině jurisdikcí.

SignatureAPI nabízí nákladově efektivní ceny pro vysokoobsávnou automatizaci. Podívejte se na podrobnosti o cenách.

Klíčové funkce

  • Více příjemců: Odeslání dokumentů až 10 podepisujících v jedné transakci.
  • Paralelní nebo sekvenční podepisování: Umožňuje odesílat dokumenty všem příjemcům najednou nebo v určitém pořadí.
  • Šablony dokumentů: Vytváření dokumentů prostřednictvím kódu programu pomocí šablon a dynamických dat
  • Jazyky a lokalizace: Přizpůsobte podpisové rozhraní pomocí různých jazyků, formátů data a času a časových pásem.
  • Podepisování bez účtů: Umožňuje příjemcům podepisovat dokumenty bez vytvoření nebo přihlášení k účtu.
  • Protokol auditu: Udržujte podrobný protokol o přístupu k dokumentu, kontrole a událostech podpisu.
  • Kontrola pravopisu proti manipulaci: Zajistěte integritu dokumentu s ověřeným, neodkazovatelným důkazem po podpisu.
  • Sledování obálek: Sledujte průběh podepisování prostřednictvím uživatelsky přívětivého řídicího panelu.
  • oznámeníReal-Time: Příjem rychlých aktualizací při podpisových aktivitách prostřednictvím e-mailu a webhooků

Požadavky

Pokud chcete tento konektor použít, zaregistrujte si účet SignatureAPI a vygenerujte klíč rozhraní API. Získejte bezplatný testovací klíč rozhraní API a nastavte připojení.

Začínáme

Nejběžnější pracovní postup zahrnuje odeslání jednoho nebo více dokumentů příjemcům k podpisu. Příjemci dostanou e-mail s odkazem pro přístup k podpisovým rozhraním.

SignatureAPI podporuje pokročilé pracovní postupy. Projděte si naše příručky ke konektorům , kde najdete podrobné pokyny, případy použití a strategie automatizace.

Krok 1: Vytvoření obálky

Začněte vytvořením prázdné obálky. Obálka je kontejner, který obsahuje dokumenty a spravuje proces podepisování.

K dispozici jsou následující možnosti:

Krok 2: Přidání příjemců

Určete, kdo musí dokumenty podepsat přidáním příjemců do obálky. V současné době se podporují jenom podepisující osoby, ale v budoucnu budou k dispozici další typy příjemců.

Krok 3: Přidání dokumentů

Přidejte do obálky dokumenty, které potřebují podpisy. Soubory PDF nebo DOCX můžete nahrát nebo vygenerovat dokumenty ze šablon pomocí dat.

Krok 4: Definování míst v dokumentech

Místa jsou určená místa v dokumentu, kde příjemce komunikuje, například podepisování, poskytování iniciály nebo přidání textu. Můžou také obsahovat statické nebo počítané hodnoty, jako jsou data dokončení.

Krok 5: Zahájení procesu podepisování

Jakmile je obálka plně připravená, zahajte proces podepisování.

Krok 6: Počkejte na dokončení obálky

Pokud chcete zachovat celý pracovní postup ve stejném toku, můžete počkat, až se obálka dokončí. Tím se zajistí, že všichni příjemci podepsali a vygeneruje se dodávka (podepsaný dokument).

Případně můžete po dokončení obálky aktivovat samostatný pracovní postup a vygenerovat dodávku.

Krok 7: Načtení podepsaného dokumentu

Po dokončení procesu načtěte podepsaný dokument (dodávku).

Práce s triggery

SignatureAPI nabízí triggery pro automatizaci pracovních postupů a zjednodušení procesů. Seznamte se s úplným seznamem triggerů a jejich používáním.

Běžně používané triggery

Při vygenerování dodávky

Aktivuje se, když se obálka dokončí a podepsaný dokument (dodávka) je připravený.

Když příjemce dokončí obálku

Aktivuje se pokaždé, když příjemce dokončí svou část procesu podepisování.

Při nedoručitelnosti e-mailu příjemce

Aktivuje se, když e-mailová adresa příjemce nemůže žádost přijmout.

Známé problémy a omezení

Běžné chyby a jejich řešení

  • Ujistěte se, že se akce Získat dodávku spustí po akci Čekání na obálku . Dodávky jsou k dispozici pouze po dokončení jejich části všem příjemcům.
  • Pokud přepnete z testovacího klíče rozhraní API na živý klíč rozhraní API, aktualizujte trigger, aby se webhook vytvořil ve správném prostředí (živém nebo testovacím). Podrobnosti najdete v našem průvodci odstraňováním potíží .

Vytvoření připojení

Konektor podporuje následující typy ověřování:
výchozí Parametry pro vytvoření připojení Všechny oblasti Nesdílitelné

Výchozí

Použitelné: Všechny oblasti

Parametry pro vytvoření připojení

Toto připojení není možné sdílet. Pokud se power app sdílí s jiným uživatelem, zobrazí se výzva k explicitní vytvoření nového připojení.

Název Typ Description Povinné
Klíč rozhraní API securestring Klíč rozhraní API pro váš účet SignatureAPI. Pravdivé

Limity omezování

Name Volání Období obnovení
Volání rozhraní API na připojení 100 60 sekund

Akce

Odstranění obálky

Odstraní obálku a všechny přidružené informace. https://signatureapi.com/docs/integrations/power-automate/actions/delete-envelope
Přidání dat do šablony

Přidá data do šablony. https://signatureapi.com/docs/integrations/power-automate/actions/add-template-data
Přidání dokumentu – DOCX

Přidá dokument DOCX do obálky. https://signatureapi.com/docs/integrations/power-automate/actions/add-document-docx
Přidání dokumentu – PDF

Přidá dokument PDF do obálky. https://signatureapi.com/docs/integrations/power-automate/actions/add-document
Přidání místa – datum dokončení obálky

Přidá do dokumentu místo pro dokončení obálky. https://signatureapi.com/docs/integrations/power-automate/actions/add-envelope-completed-date-place
Přidání místa – datum dokončení příjemce

Přidá do dokumentu datum dokončení příjemce. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient-completed-date-place
Přidání místa – iniciály

Přidá do dokumentu iniciály. https://signatureapi.com/docs/integrations/power-automate/actions/add-initials-place
Přidání místa – podpis

Přidá místo podpisu do dokumentu. https://signatureapi.com/docs/integrations/power-automate/actions/add-signature-place
Přidání místa – text

Přidá do dokumentu textové místo. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-place
Přidání místa – textové zadání

Přidá do dokumentu místo pro zadání textu. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-input-place
Přidání příjemce – podepisující osoby

Přidá příjemce do obálky. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient
Přidání šablony – DOCX

Přidá šablonu DOCX do obálky. https://signatureapi.com/docs/integrations/power-automate/actions/add-template
Vytvoření obálky

Vytvoří novou obálku, do které můžete přidat příjemce a dokumenty. Až budete připraveni, spusťte proces podepisování pomocí akce Zahájit obálku. https://signatureapi.com/docs/integrations/power-automate/actions/create-envelope
Vytvoření obřadu – ověření e-mailového odkazu

Vytvoří obřad, ve kterém se příjemce ověří prostřednictvím odkazu odeslaného na jeho e-mail. https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-email-link
Vytvoření obřadu – vlastní ověřování

Vytvoří obřad, ve kterém se příjemce externě ověřuje v SignatureAPI. Tuto možnost použijte k získání adresy URL obřadu pro sdílení s příjemci. Před použitím vlastního čtení ověřování https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-custom
Zahájení obálky

Zahájí proces podepisování obálky. https://signatureapi.com/docs/integrations/power-automate/actions/start-envelope
Získání dodávky

Načte dodávku pomocí id. Slouží ke stažení podepsané kopie obálky. https://signatureapi.com/docs/integrations/power-automate/actions/get-deliverable
Získání obálky

Načte podrobnosti obálky podle ID. https://signatureapi.com/docs/integrations/power-automate/actions/get-envelope
Získání příjemce

Načte podrobnosti o příjemci podle ID. https://signatureapi.com/docs/integrations/power-automate/actions/get-recipient
Získání zachycené hodnoty

Načte hodnotu zadaná příjemcem na vstupním místě během podepisování. https://signatureapi.com/docs/integrations/power-automate/actions/get-capture
Čekání na obálku

Čeká, až obálka dosáhne dokončeného stavu nebo jiného konečného stavu. https://signatureapi.com/docs/integrations/power-automate/actions/wait-envelope

Odstranění obálky

ID operace:
DeleteEnvelope

Odstraní obálku a všechny přidružené informace. https://signatureapi.com/docs/integrations/power-automate/actions/delete-envelope

Parametry

Name Klíč Vyžadováno Typ Description
ID obálky
 envelopeId True string

ID obálky.

Přidání dat do šablony

ID operace:
AddTemplateData

Přidá data do šablony. https://signatureapi.com/docs/integrations/power-automate/actions/add-template-data

Parametry

Name Klíč Vyžadováno Typ Description
ID dokumentu
 documentId True string

ID dokumentu.
Název pole
 field_name True string

Název pole v šabloně
Hodnota
 value True string

Hodnota pole v šabloně.

Přidání dokumentu – DOCX

ID operace:
AddDocumentDocx

Přidá dokument DOCX do obálky. https://signatureapi.com/docs/integrations/power-automate/actions/add-document-docx

Parametry

Name Klíč Vyžadováno Typ Description
ID obálky
 envelopeId True string

ID obálky.
Název dokumentu
 title string

Název tohoto dokumentu. Může se zobrazit příjemcům.
Obsah souboru
 file_content True byte

Obsah souboru dokumentu.
Další vlastnosti
 extra string

Další vlastnosti pro rozšiřitelnost

Návraty

Body
AddDocumentOutput

Přidání dokumentu – PDF

ID operace:
AddDocument

Přidá dokument PDF do obálky. https://signatureapi.com/docs/integrations/power-automate/actions/add-document

Parametry

Name Klíč Vyžadováno Typ Description
ID obálky
 envelopeId True string

ID obálky.
Název dokumentu
 title string

Název tohoto dokumentu. Může se zobrazit příjemcům.
Obsah souboru
 file_content True byte

Obsah souboru dokumentu.
Další vlastnosti
 extra string

Další vlastnosti pro rozšiřitelnost

Návraty

Body
AddDocumentOutput

Přidání místa – datum dokončení obálky

ID operace:
AddPlaceEnvelopeCompletedDate

Přidá do dokumentu místo pro dokončení obálky. https://signatureapi.com/docs/integrations/power-automate/actions/add-envelope-completed-date-place

Parametry

Name Klíč Vyžadováno Typ Description
ID dokumentu
 documentId True string

ID dokumentu.
Umístit klíč
 key True string

Klíč, který identifikuje toto místo v dokumentu.
Formát data
 date_format string

Definuje formát data a času. Informace o povolených hodnotách najdete v dokumentaci.
Číslo stránky
 page number

Číslo stránky, na které chcete toto místo umístit.
Vzdálenost od horní části
 top number

Vzdálenost (v bodech) od horní části stránky do dolní části místa.
Vzdálenost odleva
 left number

Vzdálenost (v bodech) zleva od stránky k místu.
Další vlastnosti
 extra string

Další vlastnosti pro rozšiřitelnost

Přidání místa – datum dokončení příjemce

ID operace:
AddPlaceRecipientCompletedDate

Přidá do dokumentu datum dokončení příjemce. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient-completed-date-place

Parametry

Name Klíč Vyžadováno Typ Description
ID dokumentu
 documentId True string

ID dokumentu.
Umístit klíč
 key True string

Klíč, který identifikuje toto místo v dokumentu.
Klíč příjemce
 recipient_key True string

Klíč příjemce, na který toto místo odkazuje.
Formát data
 date_format string

Definuje formát data a času. Informace o povolených hodnotách najdete v dokumentaci.
Číslo stránky
 page number

Číslo stránky, na které chcete toto místo umístit.
Vzdálenost od horní části
 top number

Vzdálenost (v bodech) od horní části stránky do dolní části místa.
Vzdálenost odleva
 left number

Vzdálenost (v bodech) zleva od stránky k místu.
Další vlastnosti
 extra string

Další vlastnosti pro rozšiřitelnost

Přidání místa – iniciály

ID operace:
AddPlaceInitials

Přidá do dokumentu iniciály. https://signatureapi.com/docs/integrations/power-automate/actions/add-initials-place

Parametry

Name Klíč Vyžadováno Typ Description
ID dokumentu
 documentId True string

ID dokumentu.
Umístit klíč
 key True string

Klíč, který identifikuje toto místo v dokumentu.
Klíč příjemce
 recipient_key True string

Klíč příjemce, na který toto místo odkazuje.
Umístit výšku
 height number

Nastavte vlastní výšku, šířka se upraví proporcionálně.
Číslo stránky
 page number

Číslo stránky, na které chcete toto místo umístit.
Vzdálenost od horní části
 top number

Vzdálenost (v bodech) od horní části stránky do dolní části místa.
Vzdálenost odleva
 left number

Vzdálenost (v bodech) zleva od stránky k místu.
Další vlastnosti
 extra string

Další vlastnosti pro rozšiřitelnost

Přidání místa – podpis

ID operace:
AddPlaceSignature

Přidá místo podpisu do dokumentu. https://signatureapi.com/docs/integrations/power-automate/actions/add-signature-place

Parametry

Name Klíč Vyžadováno Typ Description
ID dokumentu
 documentId True string

ID dokumentu.
Umístit klíč
 key True string

Klíč, který identifikuje toto místo v dokumentu.
Klíč příjemce
 recipient_key True string

Klíč příjemce, na který toto místo odkazuje.
Umístit výšku
 height number

Nastavte vlastní výšku, šířka se upraví proporcionálně.
Číslo stránky
 page number

Číslo stránky, na které chcete toto místo umístit.
Vzdálenost od horní části
 top number

Vzdálenost (v bodech) od horní části stránky do dolní části místa.
Vzdálenost odleva
 left number

Vzdálenost (v bodech) zleva od stránky k místu.
Další vlastnosti
 extra string

Další vlastnosti pro rozšiřitelnost

Přidání místa – text

ID operace:
AddPlaceText

Přidá do dokumentu textové místo. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-place

Parametry

Name Klíč Vyžadováno Typ Description
ID dokumentu
 documentId True string

ID dokumentu.
Umístit klíč
 key True string

Klíč, který identifikuje toto místo v dokumentu.
Hodnota
 value True string

Hodnota tohoto textového místa.
Velikost písma
 font_size number

Velikost písma v bodech.
Barva písma
 font_color string

Barva písma v šestnáctkovém zápisu.
Číslo stránky
 page number

Číslo stránky, na které chcete toto místo umístit.
Vzdálenost od horní části
 top number

Vzdálenost (v bodech) od horní části stránky do dolní části místa.
Vzdálenost odleva
 left number

Vzdálenost (v bodech) zleva od stránky k místu.
Další vlastnosti
 extra string

Další vlastnosti pro rozšiřitelnost

Přidání místa – textové zadání

ID operace:
AddPlaceTextInput

Přidá do dokumentu místo pro zadání textu. https://signatureapi.com/docs/integrations/power-automate/actions/add-text-input-place

Parametry

Name Klíč Vyžadováno Typ Description
ID dokumentu
 documentId True string

ID dokumentu.
Umístit klíč
 key True string

Klíč, který identifikuje toto místo v dokumentu.
Klíč příjemce
 recipient_key True string

Klíč příjemce, na který toto místo odkazuje.
Zachytit jako
 capture_as string

Klíč, který ukládá vstup příjemce a je součástí zachytávání obálek.
Hint
 hint string

Zpráva s popisem zobrazená nad vstupním polem příjemce.
Podnět
 prompt string

Zástupná zpráva zobrazená uvnitř vstupního textového pole během podpisového obřadu.
Požadavek
 requirement string

Určuje, jestli příjemce musí vyplnit toto pole, aby se dokončil podpisový obřad.
Formát
 format string

Určuje platný formát pro uživatelský vstup. Informace o povolených hodnotách najdete v dokumentaci.
Formát zprávy
 format_message string

Zpráva se zobrazí, když vstup uživatele neodpovídá požadovanému formátu.
Číslo stránky
 page number

Číslo stránky, na které chcete toto místo umístit.
Vzdálenost od horní části
 top number

Vzdálenost (v bodech) od horní části stránky do dolní části místa.
Vzdálenost odleva
 left number

Vzdálenost (v bodech) zleva od stránky k místu.
Další vlastnosti
 extra string

Další vlastnosti pro rozšiřitelnost

Přidání příjemce – podepisující osoby

ID operace:
AddRecipient

Přidá příjemce do obálky. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient

Parametry

Name Klíč Vyžadováno Typ Description
ID obálky
 envelopeId True string

ID obálky.
Jméno příjemce
 name True string

Jméno příjemce.
E-mail příjemce
 email True string

E-mailová adresa příjemce.
Klíč příjemce
 key True string

Klíč, který identifikuje příjemce v obálce.
Vytvoření obřadu příjemce
 ceremony_creation string

Jak se vytvoří obřady pro příjemce.
Typ doručení příjemce
 delivery_type string

Způsob odeslání dodávky příjemci
Další vlastnosti
 extra string

Další vlastnosti pro rozšiřitelnost

Návraty

Body
AddRecipientSignerOutput

Přidání šablony – DOCX

ID operace:
AddTemplate

Přidá šablonu DOCX do obálky. https://signatureapi.com/docs/integrations/power-automate/actions/add-template

Parametry

Name Klíč Vyžadováno Typ Description
ID obálky
 envelopeId True string

ID obálky.
Název dokumentu
 title string

Název tohoto dokumentu. Může se zobrazit příjemcům.
Obsah souboru
 file_content True byte

Obsah souboru dokumentu.
Data šablony
 data array of string

Pole: Pár hodnot obsahující data, která se mají vyplnit do šablony.
Další vlastnosti
 extra string

Další vlastnosti pro rozšiřitelnost

Návraty

Body
AddDocumentOutput

Vytvoření obálky

ID operace:
CreateEnvelope

Vytvoří novou obálku, do které můžete přidat příjemce a dokumenty. Až budete připraveni, spusťte proces podepisování pomocí akce Zahájit obálku. https://signatureapi.com/docs/integrations/power-automate/actions/create-envelope

Parametry

Name Klíč Vyžadováno Typ Description
Nadpis obálky
 title True string

Název této obálky. Může se zobrazit příjemcům.
Popisek obálky
 label string

Vlastní štítek předaný obálce pro snadnější identifikaci. Popisky jsou určené pro interní použití a nezobrazují se příjemcům.
Zpráva obálky
 message string

Zpráva, která se odešle příjemcům.
Režim obálky
 mode string

Obálky testovacího režimu nejsou závazné a nefakturují se.
Směrování obálek
 routing string

Pořadí, ve kterém příjemci podepisují obálku. Může to být paralelní, kdy se všichni příjemci můžou podepsat současně nebo postupně, kde se příjemci podepisují navzájem.
Jazyk
 language string

Výchozí jazyk, který se má použít při podpisovém obřadu a dodávkách. Pokud není zadaný, použije se výchozí jazyk účtu. https://signatureapi.com/docs/localization/language
Časová zóna
 timezone string

Časové pásmo, které se má použít pro časová razítka v dodávkách. Pokud není zadaný, použije se výchozí posun časového pásma účtu. https://signatureapi.com/docs/localization/timezone
Formát časového razítka
 timestamp_format string

Formát data a času, který se má použít v časových razítkech pro dodávky. Pokud není zadaný, použije se výchozí formát časového razítka účtu. https://signatureapi.com/docs/localization/timestamp_format
Ověření obálky
 attestation string

Ověření dodržování právních předpisů nebo dodržování předpisů
Název
 name string

Jméno odesílatele.
Email
 email string

E-mailová adresa odesílatele.
Témata obálky
 topics array of string

Slouží ke klasifikaci obálek a filtrování oznámení webhooků.
Další vlastnosti
 extra string

Další vlastnosti pro rozšiřitelnost

Návraty

Body
CreateEnvelopeOutput

Vytvoření obřadu – ověření e-mailového odkazu

ID operace:
CreateCeremonyEmailLink

Vytvoří obřad, ve kterém se příjemce ověří prostřednictvím odkazu odeslaného na jeho e-mail. https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-email-link

Parametry

Name Klíč Vyžadováno Typ Description
ID příjemce
 recipientId True string

ID příjemce.
Adresa URL pro přesměrování
 redirect_url string

Adresa URL, na které se příjemce přesměruje po dokončení obřadu. Další informace najdete v: https://signatureapi.com/docs/resources/ceremonies/redirect-url
Další vlastnosti
 extra string

Další vlastnosti pro rozšiřitelnost

Návraty

response
object

Vytvoření obřadu – vlastní ověřování

ID operace:
CreateCeremonyCustom

Vytvoří obřad, ve kterém se příjemce externě ověřuje v SignatureAPI. Tuto možnost použijte k získání adresy URL obřadu pro sdílení s příjemci. Před použitím vlastního čtení ověřování https://signatureapi.com/docs/integrations/power-automate/actions/create-ceremony-custom

Parametry

Name Klíč Vyžadováno Typ Description
ID příjemce
 recipientId True string

ID příjemce.
Zprostředkovatel ověřování
 provider True string

Název zprostředkovatele ověřování. Tato hodnota je libovolná a zobrazí se v protokolech auditu obálky.
Ověřovací data
 data True array of string

Klíč: Pár hodnot obsahující metadata ověřování. Tyto podrobnosti budou zahrnuty do protokolů auditu obálky.
Adresa URL pro přesměrování
 redirect_url string

Adresa URL, na které se příjemce přesměruje po dokončení obřadu. Další informace najdete v: https://signatureapi.com/docs/resources/ceremonies/redirect-url
Další vlastnosti
 extra string

Další vlastnosti pro rozšiřitelnost

Návraty

Body
CreateCeremonyCustomOutput

Zahájení obálky

ID operace:
StartEnvelope

Zahájí proces podepisování obálky. https://signatureapi.com/docs/integrations/power-automate/actions/start-envelope

Parametry

Name Klíč Vyžadováno Typ Description
ID obálky
 envelopeId True string

ID obálky.

Návraty

Body
StartEnvelopeOutput

Získání dodávky

ID operace:
GetDeliverable

Načte dodávku pomocí id. Slouží ke stažení podepsané kopie obálky. https://signatureapi.com/docs/integrations/power-automate/actions/get-deliverable

Parametry

Name Klíč Vyžadováno Typ Description
ID dodávky
 deliverableId True string

ID dodávky.

Návraty

Body
Deliverable

Získání obálky

ID operace:
GetEnvelope

Načte podrobnosti obálky podle ID. https://signatureapi.com/docs/integrations/power-automate/actions/get-envelope

Parametry

Name Klíč Vyžadováno Typ Description
ID obálky
 envelopeId True string

ID obálky.

Návraty

Body
Envelope

Získání příjemce

ID operace:
GetRecipient

Načte podrobnosti o příjemci podle ID. https://signatureapi.com/docs/integrations/power-automate/actions/get-recipient

Parametry

Name Klíč Vyžadováno Typ Description
ID příjemce
 recipientId True string

ID příjemce.

Návraty

Body
Recipient

Získání zachycené hodnoty

ID operace:
GetCapture

Načte hodnotu zadaná příjemcem na vstupním místě během podepisování. https://signatureapi.com/docs/integrations/power-automate/actions/get-capture

Parametry

Name Klíč Vyžadováno Typ Description
ID obálky
 envelopeId True string

ID obálky.
Zachytávání klíče
 captureKey True string

Klíč zachycené hodnoty.

Návraty

Body
Capture

Čekání na obálku

ID operace:
WaitEnvelope

Čeká, až obálka dosáhne dokončeného stavu nebo jiného konečného stavu. https://signatureapi.com/docs/integrations/power-automate/actions/wait-envelope

Parametry

Name Klíč Vyžadováno Typ Description
ID obálky
 envelopeId True string

ID obálky.

Návraty

Body
Envelope

Aktivační události

Když je příjemce odmítnut

K této události dochází, když příjemce odmítne obálku.
Když obálka selže

K této události dochází v případě selhání obálky, což vede ke stavu selhání obálky.
Když příjemce selže

K této události dochází v případě selhání souvisejícího s příjemcem, což vede k selhání stavu příjemce.
Když se příjemce nahradí

K této události dochází, když se příjemce nahradí novým příjemcem.
Když se příjemce odrazí

K této události dochází, když je e-mail neověřen, buď dočasně (soft-bounce), nebo trvale (hard-bounce).
Když se příjemce znovu odešle

K této události dochází v případě, že se žádost příjemci znovu odešle.
Po dokončení obálky

K této události dochází v případě, že stav obálky přejde z in_progress na dokončený, což znamená, že byla dokončena všemi příjemci.
Po dokončení příjemce

K této události dochází, když příjemce dokončil svou část procesu podepisování.
Po spuštění obálky

K této události dochází, když se stav obálky přesune ze zpracování na in_progress, což znamená, že je připraven k odeslání příjemcům.
Po vydání příjemce

K této události dochází, když je příjemce připraven k odeslání žádosti o dokončení obálky.
Pokud dodávky selže

K této události dochází v případě, že generování dodávky selže, což vede ke stavu selhání dodávky.
Při odeslání příjemce

K této události dochází při odeslání požadavku příjemci.
Při vygenerování dodávky

K této události dochází, když se úspěšně vygeneruje dodávka, například protokol auditu.
Při vytvoření obálky

K této události dochází při každém vytvoření obálky.
Při zrušení obálky

K této události dochází v případě, že proces podepisování byl úmyslně zastaven před dokončením, což vede ke stavu obálky zrušené.

Když je příjemce odmítnut

ID operace:
CreateEndpointForRecipientRejected

K této události dochází, když příjemce odmítne obálku.

Parametry

Name Klíč Vyžadováno Typ Description
Témata
 topics array of string

Slouží ke klasifikaci obálek a filtrování oznámení webhooků.

Návraty

Body
NotificationForRecipientRejected

Když obálka selže

ID operace:
CreateEndpointForEnvelopeFailed

K této události dochází v případě selhání obálky, což vede ke stavu selhání obálky.

Parametry

Name Klíč Vyžadováno Typ Description
Témata
 topics array of string

Slouží ke klasifikaci obálek a filtrování oznámení webhooků.

Návraty

Body
NotificationForEnvelopeFailed

Když příjemce selže

ID operace:
CreateEndpointForRecipientFailed

K této události dochází v případě selhání souvisejícího s příjemcem, což vede k selhání stavu příjemce.

Parametry

Name Klíč Vyžadováno Typ Description
Témata
 topics array of string

Slouží ke klasifikaci obálek a filtrování oznámení webhooků.

Návraty

Body
NotificationForRecipientFailed

Když se příjemce nahradí

ID operace:
CreateEndpointForRecipientReplaced

K této události dochází, když se příjemce nahradí novým příjemcem.

Parametry

Name Klíč Vyžadováno Typ Description
Témata
 topics array of string

Slouží ke klasifikaci obálek a filtrování oznámení webhooků.

Návraty

Body
NotificationForRecipientReplaced

Když se příjemce odrazí

ID operace:
CreateEndpointForRecipientBounced

K této události dochází, když je e-mail neověřen, buď dočasně (soft-bounce), nebo trvale (hard-bounce).

Parametry

Name Klíč Vyžadováno Typ Description
Témata
 topics array of string

Slouží ke klasifikaci obálek a filtrování oznámení webhooků.

Návraty

Body
NotificationForRecipientBounced

Když se příjemce znovu odešle

ID operace:
CreateEndpointForRecipientResent

K této události dochází v případě, že se žádost příjemci znovu odešle.

Parametry

Name Klíč Vyžadováno Typ Description
Témata
 topics array of string

Slouží ke klasifikaci obálek a filtrování oznámení webhooků.

Návraty

Body
NotificationForRecipientResent

Po dokončení obálky

ID operace:
CreateEndpointForEnvelopeCompleted

K této události dochází v případě, že stav obálky přejde z in_progress na dokončený, což znamená, že byla dokončena všemi příjemci.

Parametry

Name Klíč Vyžadováno Typ Description
Témata
 topics array of string

Slouží ke klasifikaci obálek a filtrování oznámení webhooků.

Návraty

Body
NotificationForEnvelopeCompleted

Po dokončení příjemce

ID operace:
CreateEndpointForRecipientCompleted

K této události dochází, když příjemce dokončil svou část procesu podepisování.

Parametry

Name Klíč Vyžadováno Typ Description
Témata
 topics array of string

Slouží ke klasifikaci obálek a filtrování oznámení webhooků.

Návraty

Body
NotificationForRecipientCompleted

Po spuštění obálky

ID operace:
CreateEndpointForEnvelopeStarted

K této události dochází, když se stav obálky přesune ze zpracování na in_progress, což znamená, že je připraven k odeslání příjemcům.

Parametry

Name Klíč Vyžadováno Typ Description
Témata
 topics array of string

Slouží ke klasifikaci obálek a filtrování oznámení webhooků.

Návraty

Body
NotificationForEnvelopeStarted

Po vydání příjemce

ID operace:
CreateEndpointForRecipientReleased

K této události dochází, když je příjemce připraven k odeslání žádosti o dokončení obálky.

Parametry

Name Klíč Vyžadováno Typ Description
Témata
 topics array of string

Slouží ke klasifikaci obálek a filtrování oznámení webhooků.

Návraty

Body
NotificationForRecipientReleased

Pokud dodávky selže

ID operace:
CreateEndpointForDeliverableFailed

K této události dochází v případě, že generování dodávky selže, což vede ke stavu selhání dodávky.

Parametry

Name Klíč Vyžadováno Typ Description
Témata
 topics array of string

Slouží ke klasifikaci obálek a filtrování oznámení webhooků.

Návraty

Body
NotificationForDeliverableFailed

Při odeslání příjemce

ID operace:
CreateEndpointForRecipientSent

K této události dochází při odeslání požadavku příjemci.

Parametry

Name Klíč Vyžadováno Typ Description
Témata
 topics array of string

Slouží ke klasifikaci obálek a filtrování oznámení webhooků.

Návraty

Body
NotificationForRecipientSent

Při vygenerování dodávky

ID operace:
CreateEndpointForDeliverableGenerated

K této události dochází, když se úspěšně vygeneruje dodávka, například protokol auditu.

Parametry

Name Klíč Vyžadováno Typ Description
Témata
 topics array of string

Slouží ke klasifikaci obálek a filtrování oznámení webhooků.

Návraty

Body
NotificationForDeliverableGenerated

Při vytvoření obálky

ID operace:
CreateEndpointForEnvelopeCreated

K této události dochází při každém vytvoření obálky.

Parametry

Name Klíč Vyžadováno Typ Description
Témata
 topics array of string

Slouží ke klasifikaci obálek a filtrování oznámení webhooků.

Návraty

Body
NotificationForEnvelopeCreated

Při zrušení obálky

ID operace:
CreateEndpointForEnvelopeCanceled

K této události dochází v případě, že proces podepisování byl úmyslně zastaven před dokončením, což vede ke stavu obálky zrušené.

Parametry

Name Klíč Vyžadováno Typ Description
Témata
 topics array of string

Slouží ke klasifikaci obálek a filtrování oznámení webhooků.

Návraty

Body
NotificationForEnvelopeCanceled

Definice

Obálka

Name Cesta Typ Description
ID obálky
 id EnvelopeId

ID obálky.
Nadpis obálky
 title EnvelopeTitle

Název této obálky. Může se zobrazit příjemcům.
Popisek obálky
 label EnvelopeLabel

Vlastní štítek předaný obálce pro snadnější identifikaci. Popisky jsou určené pro interní použití a nezobrazují se příjemcům.
Zpráva obálky
 message EnvelopeMessage

Zpráva, která se odešle příjemcům.
odesílatel
 sender EnvelopeSender
Stav obálky
 status EnvelopeStatus

Stav obálky.
proveditelný
 deliverable EnvelopeDeliverable
Obálka byla dokončena na adrese
 completed_at EnvelopeCompletedAt

Čas, kdy všichni příjemci dokončili obálku
Režim obálky
 mode EnvelopeMode

Obálky testovacího režimu nejsou závazné a nefakturují se.
Směrování obálek
 routing EnvelopeRouting

Pořadí, ve kterém příjemci podepisují obálku. Může to být paralelní, kdy se všichni příjemci můžou podepsat současně nebo postupně, kde se příjemci podepisují navzájem.
Časová zóna
 timezone EnvelopeTimezone

Časové pásmo, které se má použít pro časová razítka v dodávkách. Pokud není zadaný, použije se výchozí posun časového pásma účtu. https://signatureapi.com/docs/localization/timezone
Formát časového razítka
 timestamp_format EnvelopeTimestampFormat

Formát data a času, který se má použít v časových razítkech pro dodávky. Pokud není zadaný, použije se výchozí formát časového razítka účtu. https://signatureapi.com/docs/localization/timestamp_format
Ověření obálky
 attestation EnvelopeAttestation

Ověření dodržování právních předpisů nebo dodržování předpisů
Témata obálky
 topics EnvelopeTopics

Slouží ke klasifikaci obálek a filtrování oznámení webhooků.

Recipient

Name Cesta Typ Description
ID příjemce
 id RecipientId

ID příjemce.
ID obálky
 envelope_id EnvelopeId

ID obálky.
Typ příjemce
 type RecipientType

Typ příjemce.
Klíč příjemce
 key RecipientKey

Klíč, který identifikuje příjemce v obálce.
Jméno příjemce
 name RecipientName

Jméno příjemce.
E-mail příjemce
 email RecipientEmail

E-mailová adresa příjemce.
Stav příjemce
 status RecipientStatus

Stav příjemce.
Vytvoření obřadu příjemce
 ceremony_creation RecipientCeremonyCreation

Jak se vytvoří obřady pro příjemce.
Typ doručení příjemce
 delivery_type RecipientDeliveryType

Způsob odeslání dodávky příjemci
Příjemce byl dokončen na adrese
 completed_at RecipientCompletedAt

Čas, kdy příjemce obálku dokončil.

Proveditelný

Name Cesta Typ Description
ID dodávky
 id DeliverableId

ID dodávky.
Typ dodávky
 type DeliverableType

Typ dodávky.
Stav dodávky
 status DeliverableStatus

Stav dodávky.
Obsah souboru
 file_content DeliverableFileContent

Obsah souboru dodávky. Slouží k uložení podepsané kopie obálky.

Zachytávání

Name Cesta Typ Description
Hodnota zachytávání
 value CaptureValue

Hodnota zachytávání vstupu příjemce

CreateEnvelopeOutput

Name Cesta Typ Description
ID obálky
 id EnvelopeId

ID obálky.
Nadpis obálky
 title EnvelopeTitle

Název této obálky. Může se zobrazit příjemcům.
Popisek obálky
 label EnvelopeLabel

Vlastní štítek předaný obálce pro snadnější identifikaci. Popisky jsou určené pro interní použití a nezobrazují se příjemcům.
Zpráva obálky
 message EnvelopeMessage

Zpráva, která se odešle příjemcům.
odesílatel
 sender EnvelopeSender
Režim obálky
 mode EnvelopeMode

Obálky testovacího režimu nejsou závazné a nefakturují se.
Směrování obálek
 routing EnvelopeRouting

Pořadí, ve kterém příjemci podepisují obálku. Může to být paralelní, kdy se všichni příjemci můžou podepsat současně nebo postupně, kde se příjemci podepisují navzájem.
Časová zóna
 timezone EnvelopeTimezone

Časové pásmo, které se má použít pro časová razítka v dodávkách. Pokud není zadaný, použije se výchozí posun časového pásma účtu. https://signatureapi.com/docs/localization/timezone
Formát časového razítka
 timestamp_format EnvelopeTimestampFormat

Formát data a času, který se má použít v časových razítkech pro dodávky. Pokud není zadaný, použije se výchozí formát časového razítka účtu. https://signatureapi.com/docs/localization/timestamp_format
Ověření obálky
 attestation EnvelopeAttestation

Ověření dodržování právních předpisů nebo dodržování předpisů
Témata obálky
 topics EnvelopeTopics

Slouží ke klasifikaci obálek a filtrování oznámení webhooků.

StartEnvelopeOutput

Name Cesta Typ Description
Stav obálky
 status EnvelopeStatus

Stav obálky.

AddDocumentOutput

Name Cesta Typ Description
ID dokumentu
 id DocumentId

ID dokumentu

AddRecipientSignerOutput

Name Cesta Typ Description
ID příjemce
 id RecipientId

ID příjemce.
Jméno příjemce
 name RecipientName

Jméno příjemce.
E-mail příjemce
 email RecipientEmail

E-mailová adresa příjemce.
Klíč příjemce
 key RecipientKey

Klíč, který identifikuje příjemce v obálce.
Vytvoření obřadu příjemce
 ceremony_creation RecipientCeremonyCreation

Jak se vytvoří obřady pro příjemce.
Typ doručení příjemce
 delivery_type RecipientDeliveryType

Způsob odeslání dodávky příjemci

CreateCeremonyCustomOutput

Name Cesta Typ Description
Adresa URL obřadu
 url CeremonyUrl

Adresa URL, na které musí příjemce zahájit obřad

Id obálky

ID obálky.

ID obálky.

ID obálky
string

ObálkaTitle

Název této obálky. Může se zobrazit příjemcům.

Název této obálky. Může se zobrazit příjemcům.

Nadpis obálky
string

ObálkaLabel

Vlastní štítek předaný obálce pro snadnější identifikaci. Popisky jsou určené pro interní použití a nezobrazují se příjemcům.

Vlastní štítek předaný obálce pro snadnější identifikaci. Popisky jsou určené pro interní použití a nezobrazují se příjemcům.

Popisek obálky
string

EnvelopeMessage

Zpráva, která se odešle příjemcům.

Zpráva, která se odešle příjemcům.

Zpráva obálky
string

ObálekRout

Pořadí, ve kterém příjemci podepisují obálku. Může to být paralelní, kdy se všichni příjemci můžou podepsat současně nebo postupně, kde se příjemci podepisují navzájem.

Pořadí, ve kterém příjemci podepisují obálku. Může to být paralelní, kdy se všichni příjemci můžou podepsat současně nebo postupně, kde se příjemci podepisují navzájem.

Směrování obálek
string

EnvelopeTimezone

Časové pásmo, které se má použít pro časová razítka v dodávkách. Pokud není zadaný, použije se výchozí posun časového pásma účtu. https://signatureapi.com/docs/localization/timezone

Časové pásmo, které se má použít pro časová razítka v dodávkách. Pokud není zadaný, použije se výchozí posun časového pásma účtu. https://signatureapi.com/docs/localization/timezone

Časová zóna
string

ObálkaTimestampFormat

Formát data a času, který se má použít v časových razítkech pro dodávky. Pokud není zadaný, použije se výchozí formát časového razítka účtu. https://signatureapi.com/docs/localization/timestamp_format

Formát data a času, který se má použít v časových razítkech pro dodávky. Pokud není zadaný, použije se výchozí formát časového razítka účtu. https://signatureapi.com/docs/localization/timestamp_format

Formát časového razítka
string

EnvelopeSender

Name Cesta Typ Description
Jméno odesílatele
 name string

Jméno odesílatele.
E-mail odesílatele
 email string

E-mailová adresa odesílatele.

ObálkaStatus

Stav obálky.

Stav obálky.

Stav obálky
string

ObálkaMode

Obálky testovacího režimu nejsou závazné a nefakturují se.

Obálky testovacího režimu nejsou závazné a nefakturují se.

Režim obálky
string

ObálkyTopics

Slouží ke klasifikaci obálek a filtrování oznámení webhooků.

Name Cesta Typ Description
Položky
 string

ObálkaAttestation

Ověření dodržování právních předpisů nebo dodržování předpisů

Ověření dodržování právních předpisů nebo dodržování předpisů

Ověření obálky
string

ObálkaDeliverable

Name Cesta Typ Description
ID dodávky
 id string

ID dodávky. Pomocí tohoto příkazu si můžete stáhnout podepsanou kopii obálky.

ObálkaCompletedAt

Čas, kdy všichni příjemci dokončili obálku

Čas, kdy všichni příjemci dokončili obálku

Obálka byla dokončena na adrese
date-time

Id dokumentu

ID dokumentu

ID dokumentu

ID dokumentu
string

Id příjemce

ID příjemce.

ID příjemce.

ID příjemce
string

RecipientType

Typ příjemce.

Typ příjemce.

Typ příjemce
string

Jméno příjemce

Jméno příjemce.

Jméno příjemce.

Jméno příjemce
string

Příjemce E-mailu

E-mailová adresa příjemce.

E-mailová adresa příjemce.

E-mail příjemce
string

Klíč příjemce

Klíč, který identifikuje příjemce v obálce.

Klíč, který identifikuje příjemce v obálce.

Klíč příjemce
string

RecipientStatus

Stav příjemce.

Stav příjemce.

Stav příjemce
string

PříjemceCeremonyCreation

Jak se vytvoří obřady pro příjemce.

Jak se vytvoří obřady pro příjemce.

Vytvoření obřadu příjemce
string

RecipientDeliveryType

Způsob odeslání dodávky příjemci

Způsob odeslání dodávky příjemci

Typ doručení příjemce
string

RecipientCompletedAt

Čas, kdy příjemce obálku dokončil.

Čas, kdy příjemce obálku dokončil.

Příjemce byl dokončen na adrese
date-time

Id dodávky

ID dodávky.

ID dodávky.

ID dodávky
string

DeliverableType

Typ dodávky.

Typ dodávky.

Typ dodávky
string

Status dodávky

Stav dodávky.

Stav dodávky.

Stav dodávky
string

DeliveryableFileContent

Obsah souboru dodávky. Slouží k uložení podepsané kopie obálky.

Obsah souboru dodávky. Slouží k uložení podepsané kopie obálky.

Obsah souboru
byte

CeremonyUrl

Adresa URL, na které musí příjemce zahájit obřad

Adresa URL, na které musí příjemce zahájit obřad

Adresa URL obřadu
string

CaptureValue

Hodnota zachytávání vstupu příjemce

Hodnota zachytávání vstupu příjemce

Hodnota zachytávání
string

NotificationForEnvelopeCreated

Name Cesta Typ Description
ID události
 id EventId

ID události.
Časové razítko události
 timestamp EventTimestamp

Datum a čas události ve formátu ISO 8601.
Typ události
 type EventType

Typ události.
ID obálky
 data.envelope_id EventEnvelopeId

ID obálky, na které tato událost odkazuje.

NotificationForEnvelopeStarted

Name Cesta Typ Description
ID události
 id EventId

ID události.
Časové razítko události
 timestamp EventTimestamp

Datum a čas události ve formátu ISO 8601.
Typ události
 type EventType

Typ události.
ID obálky
 data.envelope_id EventEnvelopeId

ID obálky, na které tato událost odkazuje.

NotificationForEnvelopeCompleted

Name Cesta Typ Description
ID události
 id EventId

ID události.
Časové razítko události
 timestamp EventTimestamp

Datum a čas události ve formátu ISO 8601.
Typ události
 type EventType

Typ události.
ID obálky
 data.envelope_id EventEnvelopeId

ID obálky, na které tato událost odkazuje.

NotificationForEnvelopeFailed

Name Cesta Typ Description
ID události
 id EventId

ID události.
Časové razítko události
 timestamp EventTimestamp

Datum a čas události ve formátu ISO 8601.
Typ události
 type EventType

Typ události.
ID obálky
 data.envelope_id EventEnvelopeId

ID obálky, na které tato událost odkazuje.
Detail
 data.detail string

Informace o selhání

NotificationForEnvelopeCanceled

Name Cesta Typ Description
ID události
 id EventId

ID události.
Časové razítko události
 timestamp EventTimestamp

Datum a čas události ve formátu ISO 8601.
Typ události
 type EventType

Typ události.
ID obálky
 data.envelope_id EventEnvelopeId

ID obálky, na které tato událost odkazuje.

NotificationForRecipientReleased

Name Cesta Typ Description
ID události
 id EventId

ID události.
Časové razítko události
 timestamp EventTimestamp

Datum a čas události ve formátu ISO 8601.
Typ události
 type EventType

Typ události.
ID obálky
 data.envelope_id EventEnvelopeId

ID obálky, na které tato událost odkazuje.
ID příjemce
 data.object_id EventRecipientId

ID příjemce, na který tato událost odkazuje.
Typ příjemce
 data.recipient_type EventRecipientType

Typ příjemce, na který tato událost odkazuje.
Klíč příjemce
 data.recipient_key EventRecipientKey

Klíč příjemce této události se týká.

NotificationForRecipientSentSent

Name Cesta Typ Description
ID události
 id EventId

ID události.
Časové razítko události
 timestamp EventTimestamp

Datum a čas události ve formátu ISO 8601.
Typ události
 type EventType

Typ události.
ID obálky
 data.envelope_id EventEnvelopeId

ID obálky, na které tato událost odkazuje.
ID příjemce
 data.object_id EventRecipientId

ID příjemce, na který tato událost odkazuje.
Typ příjemce
 data.recipient_type EventRecipientType

Typ příjemce, na který tato událost odkazuje.
Klíč příjemce
 data.recipient_key EventRecipientKey

Klíč příjemce této události se týká.

NotificationForRecipientCompleted

Name Cesta Typ Description
ID události
 id EventId

ID události.
Časové razítko události
 timestamp EventTimestamp

Datum a čas události ve formátu ISO 8601.
Typ události
 type EventType

Typ události.
ID obálky
 data.envelope_id EventEnvelopeId

ID obálky, na které tato událost odkazuje.
ID příjemce
 data.object_id EventRecipientId

ID příjemce, na který tato událost odkazuje.
Typ příjemce
 data.recipient_type EventRecipientType

Typ příjemce, na který tato událost odkazuje.
Klíč příjemce
 data.recipient_key EventRecipientKey

Klíč příjemce této události se týká.

NotificationForRecipientRejected

Name Cesta Typ Description
ID události
 id EventId

ID události.
Časové razítko události
 timestamp EventTimestamp

Datum a čas události ve formátu ISO 8601.
Typ události
 type EventType

Typ události.
ID obálky
 data.envelope_id EventEnvelopeId

ID obálky, na které tato událost odkazuje.
ID příjemce
 data.object_id EventRecipientId

ID příjemce, na který tato událost odkazuje.
Typ příjemce
 data.recipient_type EventRecipientType

Typ příjemce, na který tato událost odkazuje.
Klíč příjemce
 data.recipient_key EventRecipientKey

Klíč příjemce této události se týká.
Důvod
 data.reason string

Vysvětlení zamítnutí příjemce.

NotificationForRecipientBounced

Name Cesta Typ Description
ID události
 id EventId

ID události.
Časové razítko události
 timestamp EventTimestamp

Datum a čas události ve formátu ISO 8601.
Typ události
 type EventType

Typ události.
ID obálky
 data.envelope_id EventEnvelopeId

ID obálky, na které tato událost odkazuje.
ID příjemce
 data.object_id EventRecipientId

ID příjemce, na který tato událost odkazuje.
Typ příjemce
 data.recipient_type EventRecipientType

Typ příjemce, na který tato událost odkazuje.
Klíč příjemce
 data.recipient_key EventRecipientKey

Klíč příjemce této události se týká.
Detail
 data.detail string

Informace o odrazu.

NotificationForRecipientFailed

Name Cesta Typ Description
ID události
 id EventId

ID události.
Časové razítko události
 timestamp EventTimestamp

Datum a čas události ve formátu ISO 8601.
Typ události
 type EventType

Typ události.
ID obálky
 data.envelope_id EventEnvelopeId

ID obálky, na které tato událost odkazuje.
ID příjemce
 data.object_id EventRecipientId

ID příjemce, na který tato událost odkazuje.
Typ příjemce
 data.recipient_type EventRecipientType

Typ příjemce, na který tato událost odkazuje.
Klíč příjemce
 data.recipient_key EventRecipientKey

Klíč příjemce této události se týká.
Detail
 data.detail string

Informace o selhání

NotificationForRecipient Nahrazeno

Name Cesta Typ Description
ID události
 id EventId

ID události.
Časové razítko události
 timestamp EventTimestamp

Datum a čas události ve formátu ISO 8601.
Typ události
 type EventType

Typ události.
ID obálky
 data.envelope_id EventEnvelopeId

ID obálky, na které tato událost odkazuje.
ID příjemce
 data.object_id EventRecipientId

ID příjemce, na který tato událost odkazuje.
Typ příjemce
 data.recipient_type EventRecipientType

Typ příjemce, na který tato událost odkazuje.
Klíč příjemce
 data.recipient_key EventRecipientKey

Klíč příjemce této události se týká.
Nové ID příjemce
 data.new_recipient_id string

ID nového příjemce.

NotificationForRecipientResentResent

Name Cesta Typ Description
ID události
 id EventId

ID události.
Časové razítko události
 timestamp EventTimestamp

Datum a čas události ve formátu ISO 8601.
Typ události
 type EventType

Typ události.
ID obálky
 data.envelope_id EventEnvelopeId

ID obálky, na které tato událost odkazuje.
ID příjemce
 data.object_id EventRecipientId

ID příjemce, na který tato událost odkazuje.
Typ příjemce
 data.recipient_type EventRecipientType

Typ příjemce, na který tato událost odkazuje.
Klíč příjemce
 data.recipient_key EventRecipientKey

Klíč příjemce této události se týká.

NotificationForDeliverableGenerated

Name Cesta Typ Description
ID události
 id EventId

ID události.
Časové razítko události
 timestamp EventTimestamp

Datum a čas události ve formátu ISO 8601.
Typ události
 type EventType

Typ události.
ID obálky
 data.envelope_id EventEnvelopeId

ID obálky, na které tato událost odkazuje.
ID dodávky
 data.object_id EventDeliverableId

ID dodávky, na které tato událost odkazuje.

NotificationForDeliverableFailed

Name Cesta Typ Description
ID události
 id EventId

ID události.
Časové razítko události
 timestamp EventTimestamp

Datum a čas události ve formátu ISO 8601.
Typ události
 type EventType

Typ události.
ID obálky
 data.envelope_id EventEnvelopeId

ID obálky, na které tato událost odkazuje.
ID dodávky
 data.object_id EventDeliverableId

ID dodávky, na které tato událost odkazuje.
Detail
 data.detail string

Informace o selhání

Id události

ID události.

ID události.

ID události
string

Časová známka události

Datum a čas události ve formátu ISO 8601.

Datum a čas události ve formátu ISO 8601.

Časové razítko události
date-time

EventType

Typ události.

Typ události.

Typ události
string

EventEnvelopeId

ID obálky, na které tato událost odkazuje.

ID obálky, na které tato událost odkazuje.

ID obálky
string

EventRecipientId

ID příjemce, na který tato událost odkazuje.

ID příjemce, na který tato událost odkazuje.

ID příjemce
string

EventRecipientType

Typ příjemce, na který tato událost odkazuje.

Typ příjemce, na který tato událost odkazuje.

Typ příjemce
string

EventRecipientKey

Klíč příjemce této události se týká.

Klíč příjemce této události se týká.

Klíč příjemce
string

EventDeliverableId

ID dodávky, na které tato událost odkazuje.

ID dodávky, na které tato událost odkazuje.

ID dodávky
string

objekt

Toto je typ "object".