Co webhooky dělají
Webhook je odběr konkrétní události v obchodě. Když tato událost nastane, Storeep okamžitě odešle data události na URL, kterou zadáte (typ API), nebo na e-mailovou adresu, kterou zadáte (typ E-mail). Webhooky se běžně používají pro integrace sledování objednávek, synchronizace CRM, konverze reklamních platforem a automatická oznámení.
Ke správě webhooků přejděte na Nastavení → Webhooky.
Limity webhooků
- Maximálně 20 webhooků na obchod. Pokus o přidání 21. vrátí chybu.
- Webhooky jsou seřazeny od nejnovějšího, stránkovány po 40 na stránku.
Vytvoření webhooku
Klikněte na Přidat nový webhook.
Přepínač aktivace
Pokud je zaškrtnuto (výchozí nastavení), webhook je aktivní od okamžiku uložení. Události jsou odesílány okamžitě. Zrušením zaškrtnutí uložíte webhook v deaktivovaném stavu bez přijímání událostí. Webhook můžete kdykoli aktivovat nebo deaktivovat jeho úpravou.
Název
- Povinné.
- Maximálně 50 znaků.
- Popisný štítek zobrazený v seznamu webhooků. Příklad: Facebook CAPI, objednávka vytvořena.
Typ
Řídí způsob doručení datové části události. Dvě možnosti:
- API: Storeep odešle HTTP POST požadavek s daty události na vámi zadanou URL.
- E-mail: Storeep odešle e-mail s daty události na vámi zadanou adresu.
Událost
Událost v obchodě, která spustí tento webhook. K dispozici jsou tři události:
- Relace vytvořena: spustí se při vytvoření nové relace návštěvníka ve vašem obchodě.
- Objednávka vytvořena: spustí se při zadání nové objednávky.
- Objednávka aktualizována: spustí se při změně stavu nebo dat existující objednávky.
Formát
Datový formát datové části události. Aktuálně jedna možnost:
- Json: datová část je odeslána jako dokument JSON.
URL (pouze typ API)
- Povinné, pokud je typ API.
- Maximálně 500 znaků. Vyšší limit přizpůsobuje URL, které obsahují více zástupných segmentů.
- Zadejte URL koncového bodu bez předpony
https://. Je přidána automaticky. Příklad:api.example.com/events/order. - Dynamické zástupné znaky URL: libovolné pole z datové části události lze vložit do URL pomocí syntaxe dvojitých složených závorek:
{{field_name}}. Například:https://example.com/postback?cid={{fbclid}}&payout={{order_total}}
To vám umožňuje odesílat konverzní data reklamním platformám přímo z URL webhooku bez samostatného proxy serveru. - Pokud je struktura URL po vyřešení zástupných znaků neplatná, dostanete chybu ověření.
E-mailová adresa (pouze typ e-mail)
- Povinné, pokud je typ E-mail.
- Musí být platná e-mailová adresa, maximálně 127 znaků.
Úprava webhooku
Kliknutím na libovolný řádek webhooku otevřete editor. Všechna pole jsou editovatelná. Pole URL se předvyplní pouze pokud je aktuální typ API; pole e-mailu se předvyplní pouze pokud je aktuální typ E-mail. Přepnutí typu vymaže druhé pole.
Aktivace a deaktivace webhooků
Zaškrtávací políčko Aktivovat v horní části editoru řídí, zda webhook odesílá. Stav v seznamu zobrazuje Aktivováno nebo Deaktivováno. Deaktivovaný webhook nezaznamenává žádná doručení, ale není smazán, takže ho můžete znovu aktivovat bez nutnosti překonfigurování.
Sloupce seznamu webhooků
- Název: štítek webhooku s datem vytvoření.
- URL / E-mail: cílová adresa.
- Typ: API nebo E-mail.
- Událost: název události (Relace vytvořena, Objednávka vytvořena nebo Objednávka aktualizována).
- Formát: Json.
- Stav: Aktivováno nebo Deaktivováno.
Smazání webhooku
Vyberte jeden nebo více webhooků a klikněte na Smazat webhooky. Tato akce je trvalá a zastaví veškerá budoucí doručení pro daný odběr.
Tipy a potenciální problémy
- Pro stejnou událost můžete vytvořit více webhooků, například odeslat Objednávka vytvořena do CRM i do reklamní platformy, každý jako samostatný záznam webhooku.
- Pokud váš koncový bod vyžaduje ověřování, přidejte přihlašovací údaje do řetězce dotazu URL pomocí
{{zástupného_znaku}}ze zdrojových dat události, nebo nastavte proxy server, který zpracuje ověřování před předáním skutečnému koncovému bodu. - Událost Relace vytvořena se spouští pro každou jedinečnou relaci návštěvníka, což může mít vysoký objem v populárních obchodech. Přihlaste se k odběru pouze v případě, že váš koncový bod zvládne propustnost.