Nastavení obchodu

Jak nastavit webhooky pro odesílání událostí objednávek a relací na API nebo e-mail?

Vytvářejte a spravujte webhooky v Nastavení: zvolte API nebo E-mail, vyberte událost vytvoření relace, objednávky nebo aktualizace objednávky, používejte URL s {{placeholder}}, a zjistěte limity, retry backoff a e-mail o selhání po 5 neúspěších.

Co dělají webhooky

Webhook se přihlásí k odběru konkrétní události v obchodě. Když tato událost nastane, Storeep okamžitě odešle data události na URL, kterou zadáte (API typ), nebo na e-mailovou adresu, kterou zadáte (E-mail typ). Webhooky se běžně používají pro integrace sledování objednávek, synchronizaci s CRM, konverze reklamních platforem a automatizovaná upozornění.

Pro správu webhooků přejděte do Nastavení → Webhooky. Pro zobrazení nebo změnu webhooků potřebujete oprávnění settings.

Limity webhooků

Maximálně 20 webhooků na obchod. Pokus o přidání 21. webhooku vrátí chybu "You have reached the maximum of 20 webhooks per store".
Seznam zobrazuje webhooky od nejnovějších, stránkování po 40 na stránku.

Vytvoření webhooku

Klikněte na Přidat nový webhook, vyplňte níže uvedená pole a klikněte na Přidat.

Aktivovat

Zaškrtnuto ve výchozím stavu. Pokud je zaškrtnuto, webhook je aktivní ihned po uložení a odpovídající události se odesílají. Pokud nezaškrtnete, webhook se uloží jako neaktivní a nic neodesílá. Toto nastavení můžete kdykoliv změnit úpravou webhooku.

Název

Povinné. Maximálně 50 znaků.
Popisný štítek zobrazený v seznamu, například Facebook CAPI order created.

Typ

API: Storeep odešle HTTP POST požadavek s daty události na vaši URL.
E-mail: Storeep odešle e-mail s daty události na vaši adresu.

Událost

Událost v obchodě, která spouští webhook. Existují tři události:

Session created: v obchodě je vytvořena nová návštěvnická relace.
Order created: je vytvořena nová objednávka.
Order updated: změní se stav nebo data existující objednávky.

Důležité: typ E-mail doručuje pouze Order created a Order updated. Pokud zvolíte E-mail s Session created, webhook se uloží, ale nikdy nic neodešle. Pokud potřebujete událost relace, použijte typ API.

Formát

Pouze jedna možnost, Json: payload je odeslán jako JSON dokument.

URL (pouze typ API)

Povinné, pokud je typ API. Maximálně 500 znaků.
Pole zobrazuje předponu https://, takže zadejte pouze hostitele a cestu, například api.example.com/events/order. Pokud vložíte celou adresu s https:// nebo http://, předpona bude před uložením odstraněna.
Dynamické zástupné znaky: vložte jakékoli pole z dat události do URL pomocí dvojitých složených závorek {{field_name}}. Příklad: example.com/postback?cid={{fbclid}}&payout={{order_total}}. Hodnoty jsou URL kódovány a pokud pole chybí, zástupný znak bude prázdný. Díky tomu můžete posílat konverzní data přímo na reklamní platformu bez proxy.
Adresa je ověřena po odstranění zástupných znaků, takže neplatná URL vrátí "The url you have entered is incorrect".

E-mailová adresa (pouze typ E-mail)

Povinné, pokud je typ E-mail. Musí být platná adresa, maximálně 127 znaků.

Úprava webhooku

Klikněte na libovolný řádek pro otevření editoru. Každé pole lze upravit. Pole URL se předvyplní pouze pokud je uložený typ API, pole e-mailu pouze pokud je uložený typ E-mail. Klikněte na Uložit pro potvrzení. Uložení s nezaškrtnutým Aktivovat webhook deaktivuje, ale nesmaže.

Sloupce v seznamu webhooků

Název: štítek s datem vytvoření.
URL / E-mail: cílová adresa.
Typ: API nebo E-mail.
Událost: Session created, Order created nebo Order updated.
Formát: Json.
Stav: Aktivováno nebo Deaktivováno.

Smazání webhooku

Vyberte jeden nebo více řádků a klikněte na Smazat webhooky. Smazání je trvalé a zastaví všechna budoucí doručení pro toto předplatné.

Doručení, opakování a e-maily o selhání

Tato sekce platí pro webhooky typu API. Webhooky typu E-mail se odesílají pouze jednou bez opakování a bez sledování selhání.

Chování při opakování

Každý požadavek má časový limit 5 sekund. Pokud cílový server vrátí 5xx chybu, 429 (rate limited), nebo není dosažitelný (chyba připojení), doručení je považováno za dočasné selhání a je opakováno.
Po prvním selhání Storeep opakuje doručení s exponenciálním zpožděním až 5x: přibližně za 30s, 60s, 120s, 240s a poté 480s. Po posledním pokusu je událost zahozena.
Odpověď 4xx kromě 429 (například 404 nebo 403) je považována za trvalé selhání. Storeep ji neopakuje, protože špatný nebo odmítající endpoint se sám neopraví.
Pokud máte více webhooků na stejnou událost, opakování se týká pouze těch, které selhaly. Endpointy, které již vrátily úspěch, jsou přeskočeny, takže nedostanete duplicitní doručení.

Upozornění na selhání e-mailem

Storeep počítá po sobě jdoucí selhání doručení pro každý webhook. Po 5 po sobě jdoucích selháních obdrží vlastník obchodu jeden e-mail s předmětem "Action needed: your Storeep webhook is failing" v jazyce vlastníka, s uvedením názvu webhooku, cíle, události a posledního HTTP status kódu.
Obdržíte přesně jeden e-mail na každou sérii selhání. Další e-maily nejsou odesílány, dokud se webhook nezotaví.
Jakmile se doručení opět podaří, čítač selhání se vynuluje a upozornění se znovu aktivuje, takže při další sérii selhání vám může přijít nový e-mail.

Tipy a úskalí

Můžete vytvořit více webhooků pro stejnou událost, například poslat Order created jak do CRM, tak na reklamní platformu jako dvě samostatné položky.
Pokud váš endpoint vyžaduje autentizaci, vložte token do URL jako parametr, buď natvrdo, nebo pomocí {{placeholder}} z dat události, nebo použijte proxy, která přidá autentizaci před předáním dál.
Session created se spouští pro každou unikátní návštěvnickou relaci a může mít vysoký objem na vytížených obchodech. Přihlašujte se k ní jen pokud vaše endpointy zvládnou tento provoz, a pamatujte, že funguje pouze s typem API.