Přeskočit na hlavní obsah

Webhooky

Záložka Webhooky slouží ke správě webhooků, které umožňují propojit Siesta AI s externími systémy a aplikacemi. Webhook poskytuje unikátní URL adresu, na kterou může externí služba odesílat HTTP požadavky a tím spouštět nebo ovlivňovat chování systému.

Webhooky najdete v levém menu pod Webhooks.

Každý webhook:

  • má vlastní název,
  • může mít přiřazený API klíč,
  • může být aktivní nebo neaktivní,
  • má jedinečnou URL adresu.

Webhooky se často používají jako triggery pro Workflows, které lze spouštět z externích systémů.

Přehled webhooků​

Na hlavní obrazovce záložky Webhooky je zobrazen seznam všech vytvořených webhooků v tabulce.

Zobrazené sloupce:

  • Název – název webhooku zadaný uživatelem
  • URL – automaticky generovaná URL adresa webhooku
  • Created by – tvůrce a vlastník webhooku
  • Stav – aktuální stav webhooku (Aktivní / Neaktivní)
  • Akce – další možnosti správy webhooku (např. úprava)

V horní části stránky je dostupné:

  • vyhledávací pole,
  • tlačítko Přidat webhook.

Přehled webhooků

Webhooks.View, Webhooks.Edit a Webhooks.Delete platí pro vlastní webhooky. Pro webhook jiného uživatele potřebujete navíc Webhooks.ManageAll. Při kontrole sdílené automatizace najděte odpovědného vlastníka ve sloupci Created by.

Vytvoření nového webhooku​

Kliknutím na Přidat webhook se otevře dialog pro vytvoření nového webhooku.

Pole formuláře

  • Název – povinné pole pro zadání názvu webhooku (např. Webhook)
  • Aktivní – přepínač, kterým lze webhook při vytvoření rovnou aktivovat nebo ponechat neaktivní
  • API klíč – volitelný výběr klíče, který bude volání webhooku autorizovat

Akce

  • Zrušit – zavře dialog bez vytvoření webhooku
  • Vytvořit – vytvoří nový webhook a vygeneruje jeho URL

Vytvoření webhooku

Detail webhooku​

Po otevření konkrétního webhooku se zobrazí jeho detailní stránka.

Zobrazené informace:

  • název webhooku,
  • stav (aktivní / neaktivní),
  • URL webhooku – unikátní adresa, kterou lze zkopírovat jedním kliknutím.

Z detailu webhooku je možné:

  • upravit nastavení webhooku,
  • měnit jeho aktivní stav,
  • používat URL webhooku v externích aplikacích nebo ve Workflows.

Detail webhooku

Volání webhooku z externího systému​

Zkopírujte URL z detailu webhooku a odešlete JSON metodou POST. Pokud má webhook přiřazený API klíč, pošlete ho v hlavičce X-Api-Key. Webhook bez přiřazeného klíče používá token ve své URL; s celou adresou proto zacházejte jako s přihlašovacím údajem.

curl -X POST "<WEBHOOK_URL>" \
  -H "X-Api-Key: <WEBHOOK_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"event":"invoice.created","id":"123"}'

Hlavičku X-Api-Key vynechte pouze u webhooku bez přiřazeného klíče. Vedle HTTP odpovědi ověřte také běh workflow; přijetí požadavku nepotvrzuje úspěch všech jeho uzlů.

Stav webhooku​

Stav webhooku určuje, zda je webhook připraven přijímat požadavky:

  • Aktivní – webhook je zapnutý a dostupný
  • Neaktivní – webhook je vypnutý a požadavky nejsou zpracovány

Stav je viditelný jak v přehledu webhooků, tak v detailu webhooku.

Typické využití webhooků​

Webhooky se používají zejména pro:

  • integraci Siesta AI s externími aplikacemi,
  • spouštění automatizovaných procesů,
  • napojení vlastních skriptů (např. Python),
  • přenos dat mezi systémy v reálném čase.

Shrnutí​

Webhooky v Siesta AI poskytují jednoduchý a bezpečný způsob, jak propojit platformu s externími systémy. Díky přehledné správě, vazbě na API klíče a možnosti aktivace či deaktivace lze webhooky snadno kontrolovat a spravovat. Pokud webhook používáte jako trigger, doporučujeme jeho použití navázat na Workflows.

Naposledy aktualizováno