Konfigurace nového webhooku

Možnosti konfigurace

Konfigurace webhooku vyžaduje definování pěti prvků, kterými jsou:

• Název – Je doporučeno použít intuitivní název, který ostatní správci snadno pochopí.
• Rozsah – Určuje šířku sítě pro použití webhooku? V rozhraní je k dispozici Účet a Skupina.
  • Rozhraní API podporuje rozsahy Účet, Skupina, Uživatel a Zdroje.
  • K jednomu webhooku lze nastavit pouze jeden rozsah.
• Adresa URL – Cílová adresa URL, na kterou služba Acrobat Sign přesunula datovou část JSON.
• Události – Aktivační událost, která způsobí, že služba Acrobat Sign sestaví JSON a odešle jej na adresu URL.
  • Každá událost vytváří jinou datovou část, která souvisí s aktivační událostí.
  • Do jednoho webhooku lze zahrnout více událostí.
• Parametry oznámení – Parametry oznámení identifikují jednotlivé sekce datové části JSON události, a umožňují tak vybrat pouze ty sekce události, které jsou pro tento webhook důležité (a tím omezit zbytečná data odesílaná na adresu URL).

Jakmile bude webhook plně definován, klikněte na tlačítko Uložit a nový webhook začne okamžitě reagovat na aktivační události. 

Rozsahy ověřování

• Účet: Všechny odebírané události, které se vyskytnou na účtu, aktivují odeslání.
  
  • Správci účtu mají oprávnění k zobrazení všech webhooků definovaných pro účet a všechny skupiny v rámci tohoto účtu.
• Skupina: Všechny odebírané události, které se vyskytnou ve skupině, aktivují odeslání. POZNÁMKA: Webhooky s rozsahem vymezeným na skupinu existují pouze pro tuto jednu skupinu.
  • Správci skupiny uvidí pouze webhooky, které jsou určeny pro jejich skupinu. Neuvidí webhooky na úrovni účtu ani webhooky vázané na jiné skupiny.
  • Pro účty, které mají aktivovánu funkci Uživatelé ve více skupinách, se zobrazí možnost k nastavení skupiny, na kterou se má rozsah vztahovat.
    
• Uživatelský účet: Všechny odebírané události pro uživatelský účet aktivují odeslání. Webhooky na úrovni uživatele lze vytvářet pouze přes rozhraní API.
• Webhook na úrovni zdroje: Bude vytvořen pro konkrétní zdroj. Události specifické pro tento zdroj budou odesílány na adresu URL webhooku. Webhooky na úrovni zdroje lze vytvářet pouze přes rozhraní API.

Adresa URL

Adresa URL webhooku je server, jenž naslouchá příchozím oznamovacím zprávám HTTPS POST, které jsou aktivovány při výskytu událostí.

Tuto adresu URL potřebujete k přihlášení webhooku k odběru událostí.

• Klient musí obsahovat adresu HTTPS URL, na kterou může služba Acrobat Sign zasílat zprávy POST. Tato adresa URL musí být dostupná na veřejném internetu.  
  • Například URI 127.0.0.1 a localhost nebudou fungovat.
  • Koncový bod adresy URL musí naslouchat na portu 443 nebo 8443 (rozhoduje zákazník při definování adresy URL zpětného volání).
• Ujistěte se, že webhook podporuje požadavky POST pro příchozí oznámení událostí a požadavky GET pro žádost o ověření.
• Adresa URL nesmí být blokována bránou firewall.

Události

Níže jsou uvedeny události, které mohou aktivovat odeslání na adresu URL webhooku, seskupené podle objektu a vypsané v pořadí, v jakém se nacházejí v uživatelském rozhraní.

Hodnota uvedená vlevo je hodnota, která se zobrazí v uživatelském rozhraní služby Acrobat Sign. Hodnota uvedená vpravo je název webhooku v rozhraní API.

Úplné podrobné informace týkající se webhooků a jejich datových částí naleznete v příručce pro vývojáře služby Acrobat Sign.

Dohody:

Hromadné odeslání:

Webové formuláře:

Šablony knihoven (pouze rozhraní API):

Parametry upozornění

Parametry upozornění umožňují přizpůsobit datovou část JSON pouze určitým prvkům události.

Například v případě události Účastník dohody nahrazen můžete chtít pouze informace o dohodě a informace o účastníkovi, zatímco informace o dokumentu můžete chtít vynechat, aby se zmenšila celková velikost souboru JSON odesílaného na adresu URL webhooku.

• Dohoda
  • Informace o dohodě – podrobné informace o dohodě založené na stavu dohody v době aktivační události.
  • Informace o dokumentu dohody – zahrnuje veškeré informace o dokumentu generované v důsledku události.
  • Informace o účastníkovi dohody – zahrnuje veškeré informace o účastníkovi v důsledku události.
  • Podepsaný dokument dohody – poskytuje podepsaný dokument PDF. 
    • Platí pro možnosti Pracovní postup dohody dokončen a Všechny události dohody.
• Hromadné odeslání
  
  • Informace o hromadném odeslání – podrobné informace o objektu Hromadné odeslání, který událost aktivoval.
• Webový formulář
  • Informace o widgetu – podrobné informace o webovém formuláři, který událost aktivoval.
  • Informace o dokumentu widgetu – informace o dokumentu spojené s webovým formulářem.
    
  • Informace o účastníkovi widgetu – informace o definovaných účastnících ve webovém formuláři.