Webhooky
Články nápovědy nemusí být zcela přesné – kvůli častým aktualizacím a automatickému překladu mohou zaostávat za aplikací. V případě pochybností kontaktujte podporu.
Na této stránce
Webhook připraví váš vlastní systém na okamžik, kdy se v EventMannu něco stane, takže se nemusíte neustále dotazovat. EventMann odešle požadavek HTTPS na adresu, kterou zvolíte, pokaždé, když nastane některá z událostí, k nimž jste se přihlásili: rezervace je potvrzena, objednávka je vrácena, akce je zveřejněna. Webhooky najdete na záložce Webhooky v sekci Integrace v postranním panelu.
- Otevřete Integrace a klikněte na záložku Webhooky.
- Klikněte na Přidat webhook a vytvořte koncový bod.
- Sloupec Stav ukazuje, zda je koncový bod Aktivní, nebo Zakázaný, a HTTP stav posledního pokusu.
- Zakázaný koncový bod nabízí tlačítko Znovu povolit.
Přidání koncového bodu
- Zadejte Název pro vlastní potřebu.
- Zadejte URL koncového bodu, veřejnou webovou adresu, která přijímá požadavky POST.
- Zaškrtněte události, které chcete, v sekci Přihlásit se k odběru událostí. Alespoň jedna je povinná.
- Klikněte na Přidat webhook. Vytvoří se pro vás 64znakový podpisový tajný klíč.
Události, které můžete vybrat
Formulář nabízí patnáct událostí a každá z nich se odesílá:
| Událost | Odesláno, když |
|---|---|
booking.created | Vznikne objednávka: u pokladny u bezplatných objednávek a objednávek s žádostí o schválení, u placených objednávek v kroku platby. |
booking.confirmed | Objednávka je potvrzena: zaplacená, bezplatná nebo zadaná ručně. |
payment.received | Platba se vypořádá. Odesílá se společně s událostí booking.confirmed, včetně bezplatných objednávek. |
booking.cancelled | Objednávka je zrušena: kupujícím, vámi nebo vaším týmem, nebo podporou EventMannu. Pole cancelled_by uvádí, kdo to byl (attendee, organizer nebo admin). |
booking.refunded | Objednávka je vrácena v plné výši. |
payment.refunded | Vrácení se vypořádá, včetně částečných. Jedna událost na každé vrácení, s jeho částkou. |
event.created | Akce je vytvořena, ať už průvodcem, kopírováním, nebo jako součást opakující se řady. |
event.updated | Podrobnosti akce se změní: název, popis, obrázek, termíny, místo nebo adresa, online odkaz, prodejní okno, viditelnost. Pole changed uvádí změněné položky. Změna stavu není aktualizace; má vlastní události. |
event.published | Akce je zveřejněna. |
event.cancelled | Akci zrušíte. |
ticket.checked_in | Vstupenka je vpuštěna u vchodu: naskenováním, ručním zadáním, hromadným odbavením, synchronizací z offline skeneru nebo prodejem a vpuštěním na pokladně. Odhlášení vstupenky a označení nedostavení se neodesílá, stejně tak ne hromadná akce Odbavit v seznamu objednávek, která označí celé objednávky jako přijaté bez naskenování u vchodu. |
staff.assigned | Někdo se stane personálem akce: schválíte jeho přihlášku, nebo přijme pozvání na tuto akci. |
staff.checked_in | Člen personálu se přihlásí do směny. |
vendor.assigned | Přiřadíte dodavatele k akci. |
vendor.invoice_submitted | Dodavatel odešle fakturu k zakázce. |
Výplatní události neexistují. Stripe posílá prodej vstupenek přímo na váš vlastní účet a EventMann tyto výplaty nevytváří ani je nevidí.
Jak vypadá doručení
Každé doručení je požadavek POST s tělem JSON v tomto tvaru: event (název), data (podrobnosti), timestamp a delivery_id. Data pro booking.confirmed obsahují ID objednávky, referenci, stav, celkovou částku, jméno a e-mail účastníka, ID akce a čas potvrzení. booking.created přidává název akce a místo toho uvádí čas vytvoření. payment.received obsahuje ID rezervace, částku, platební bránu, ID transakce a čas.
Požadavek nese tři hlavičky: X-Webhook-Event, X-Webhook-Delivery-Id a X-Webhook-Signature. Podpis je HMAC-SHA256 nezpracovaného těla požadavku v šestnáctkové soustavě, klíčovaný podpisovým tajným klíčem vašeho koncového bodu. Na své straně jej přepočítejte z nezpracovaného těla a porovnejte, než datům uvěříte.
Kontrola koncového bodu
- Klikněte na Odeslat test a na vaši adresu se odešle ukázkový požadavek
ping. Výsledek uvidíte hned. - Odebírané události ukazují, co koncový bod dostává. Pomocí Upravit změníte název, adresu nebo události.
- Podpisový tajný klíč je skrytý; klikněte na Zobrazit, abyste jej zobrazili.
- Nedávná doručení ukazují posledních několik pokusů s událostí, stavem, HTTP kódem, dobou trvání a časem. Zobrazit vše ukáže další.
Opakování, selhání a automatické vypnutí
- Za doručené se počítá pouze odpověď 2xx. Přesměrování nebo jakákoli jiná odpověď je selhání; přesměrování se nesledují.
- Neúspěšné doručení se zkouší až pětkrát, s čekáním 10, 30 a potom 60 sekund mezi pokusy.
- Když selžou všechny pokusy u jedné události, počet selhání koncového bodu se zvýší o jedna. Deset selhání během jedné hodiny pozastaví doručování na tento koncový bod na pět minut; doručení počkají na konec pauzy.
- Pokud se pauza spustí, nebo počet selhání přesáhne deset, koncový bod se vypne a dostanete oznámení s jeho názvem.
- Adresa, která ukazuje do soukromé nebo interní sítě, se při pokusu o doručení odmítne. Test zobrazí „Blokováno“ a skutečné doručení koncový bod vypne.
- Historie doručení se uchovává 30 dní.
- Zakázaný koncový bod zobrazí Tento koncový bod je zakázán s uvedením důvodu.
- Opravte, co bylo na vašem přijímači špatně, a potom klikněte na Znovu povolit. Počet selhání se vynuluje; adresa a tajný klíč zůstanou stejné. Změna názvu nebo adresy koncový bod znovu nepovolí.
- Zkusit znovu u neúspěšného doručení odešle danou událost znovu jako nové doručení všem vašim aktuálně aktivním koncovým bodům, které ji odebírají. Patří sem i vaše další koncové body, takže je může dostat dvakrát.
Dobré vědět
- Odesílání webhooků běží na vlastní frontě, takže pomalý přijímač nemůže zpomalit rezervace ani e-maily se vstupenkami.
- Odškrtnutí události ji tiše zastaví. O tom, že jste přestali události dostávat, nedostanete žádné upozornění.
- Pokud připojíte nástroj jako Zapier pomocí API tokenu EventMannu, předplatná, která vytvoří, se zde také zobrazí, pojmenovaná podle události.
- Webhooky odesílají jméno a e-mail účastníka každé objednávky na váš server. Ujistěte se, že adresa patří vám a že smíte tyto údaje zpracovávat.
Řešení problémů
- Doručování se zastavilo a nevidím žádnou chybu — otevřete koncový bod. Pokud je zakázaný, opravte přijímač a klikněte na Znovu povolit.
- Podpis se nikdy neshoduje — zahashujte přesné nezpracované tělo, ne jeho znovu zakódovanou kopii, s tajným klíčem z vaší stránky koncového bodu a porovnávejte text v šestnáctkové soustavě.
- Test funguje, ale skutečné události nedorazí — zkontrolujte, zda je událost na tomto koncovém bodu zaškrtnutá a zda se to, co se stalo, shoduje se sloupcem „Odesláno, když“ v tabulce.
- Dostávám stejnou událost dvakrát — stiskli jste Zkusit znovu, nebo máte k této události přihlášené dva koncové body. Pro ignorování opakování použijte ID doručení.