
Přehled
Webhooky v Twenty doplňují API tím, že umožňují oznámení v reálném čase do vašich aplikací, když se události stanou ve vašem CRM. Místo neustálého dotazování API na změny můžete nastavit webhooky, které umožní aplikaci Twenty odesílat data do vašeho systému vždy, když dojde ke specifickým událostem (například když je vytvořen nový záznam nebo aktualizován stávající). To pomůže udržet externí systémy synchronizované s Twenty okamžitě a efektivně. S využitím webhooků Twenty odešle požadavek HTTP POST na URL, které určíte, a to včetně podrobností o události. Můžete pak tato data zpracovat ve vaší aplikaci (např. pro aktualizaci vaší externí databáze, spuštění pracovních postupů nebo odesílání upozornění).Nastavení Webhooku
Chcete-li vytvořit webhook v Twenty, použijte nastavení API & Webhooks ve vaší aplikaci Twenty:- Přejděte do Nastavení: V aplikaci Twenty přejděte do Nastavení → API & Webhooks.
- Vytvořit Webhook: Pod Webhooky klikněte na + Vytvořit webhook.
- Zadejte URL: Poskytněte koncovou URL na vašem serveru, kam chcete, aby Twenty zasílalo požadavky webhooků. Toto by měla být veřejně přístupná URL, která zvládne POST požadavky.
- Uložit: Klikněte na Uložit pro vytvoření webhooku. Nový webhook bude aktivní okamžitě.
Události a Zatížení
Jakmile je webhook nastaven, Twenty pošle HTTP POST požadavek na vámi specifikovanou URL vždy, když dojde ke spouštěcí události ve vašich CRM datech. Běžné události, které spouští webhooky, zahrnují:- Záznam Vytvořen: např. je přidána nová osoba (
person.created), vytvořena nová firma (company.created), nebo vytvořen záznam (note.created), atd. - Záznam Aktualizován: např. jsou aktualizovány informace stávající osoby (
person.updated), editován záznam firmy (company.updated), atd. - Záznam Smazán: např. osoba nebo firma je smazána (
person.deleted,company.deleted). - Další Události: pokud je to relevantní, jiné události objektů nebo vlastní spouštěče (například pokud jsou úkoly nebo jiné objekty aktualizovány, budou použity podobné typy událostí jako
task.created,note.updated, atd.).
"událost"specifikuje, co se stalo (person.created)."data"obsahuje detaily nového záznamu (stejné informace, které byste získali, pokud byste požádali o danou osobu přes API)."časová značka"je kdy daná událost nastala (v UTC).
"událost", abyste pochopili, co se stalo, a pak podle potřeby použít "data" (např. vytvořit nový kontakt ve vašem systému nebo aktualizovat stávající).
Poznámka: Je důležité reagovat z vašeho webhookového koncového bodu s 2xx HTTP statusem, aby bylo potvrzeno úspěšné přijetí. Pokud Twenty webhook sender nedostane odpověď 2xx, může považovat doručení za neúspěšné. (V budoucnu může logika pokusů o nové odeslání pokusit se znovu odeslat neúspěšné webhooky, proto se vždy snažte vrátit 200 OK co nejrychleji po zpracování dat.)
Ověření Webhooku
Pro zajištění bezpečnosti vašich webhookových koncových bodů obsahuje Twenty podpis v hlavičceX-Twenty-Webhook-Signature.
Tento podpis je HMAC SHA256 hash payloadu požadavku, vypočítaný pomocí vašeho webhookového tajemství.
Pro ověření podpisu budete potřebovat:
- Spojte časovou značku (z hlavičky
X-Twenty-Webhook-Timestamp), dvojtečku a JSON řetězec payloadu - Vypočítejte HMAC SHA256 hash pomocí vašeho webhookového tajemství jako klíče
- Porovnejte vzniklý hex digest s hlavičkou podpisu