Nastavenia obchodu

Ako nastavím webhooky na odosielanie udalostí objednávok a relácií do API alebo e-mailu?

Vytvorte a spravujte webhooky obchodu v Nastaveniach: vyberte API alebo E-mail, zvoľte udalosť vytvorenia relácie, vytvorenia objednávky alebo aktualizácie objednávky, použite URL s {{zástupcom}} a spoznajte limit 20 webhookov, opätovné pokusy a e-mail o zlyhaní.

Čo robia webhooky

Webhook sa prihlási na odber konkrétnej udalosti obchodu. Keď táto udalosť nastane, Storeep okamžite odošle dáta udalosti na URL, ktorú zadáte (typ API), alebo na e-mailovú adresu, ktorú zadáte (typ E-mail). Webhooky sa bežne používajú na integrácie sledovania objednávok, synchronizácie CRM, konverzie reklamných platforiem a automatizované oznámenia.

Na správu webhookov prejdite na Nastavenia → Webhooky. Na zobrazenie alebo zmenu webhookov potrebujete povolenie nastavenia.

Limity webhookov

Maximálne 20 webhookov na obchod. Pokus o pridanie 21. vráti chybu "Dosiahli ste maximum 20 webhookov na obchod".
Zoznam zobrazuje webhooky od najnovších, stránkované po 40 na stranu.

Vytvorenie webhooku

Kliknite na Pridať nový webhook, vyplňte polia nižšie a potom kliknite na Pridať.

Aktivovať

Predvolene zaškrtnuté. Keď je zaškrtnuté, webhook je živý vo chvíli, keď ho uložíte, a zhodujúce sa udalosti sa odosielajú. Zrušte zaškrtnutie, aby ste webhook uložili v deaktivovanom stave, ktorý nič neprijíma. Toto môžete kedykoľvek prepnúť úpravou webhooku.

Názov

Povinný. Maximálne 50 znakov.
Popisný štítok zobrazený v zozname, napríklad Facebook CAPI vytvorenie objednávky.

Typ

API: Storeep odošle HTTP POST požiadavku nesúcu dáta udalosti na vašu URL.
E-mail: Storeep odošle e-mail obsahujúci dáta udalosti na vašu adresu.

Udalosť

Udalosť obchodu, ktorá spúšťa webhook. Existujú tri udalosti:

Vytvorenie relácie: vo vašom obchode sa vytvorí nová relácia návštevníka.
Vytvorenie objednávky: je zadaná nová objednávka.
Aktualizácia objednávky: zmení sa stav alebo dáta existujúcej objednávky.

Dôležité: typ E-mail doručuje iba Vytvorenie objednávky a Aktualizáciu objednávky. Ak vyberiete E-mail s Vytvorením relácie, webhook sa uloží, ale nikdy nič neodošle. Ak potrebujete udalosť relácie, použite typ API.

Formát

Len jedna možnosť, Json: užitočné zaťaženie sa odosiela ako dokument JSON.

URL (iba typ API)

Povinné, keď je typ API. Maximálne 500 znakov.
Pole vám zobrazuje predponu https://, takže zadajte iba hostiteľa a cestu, napríklad api.example.com/events/order. Ak vložíte úplnú adresu https:// alebo http://, predpona sa pred uložením odstráni.
Dynamickí zástupcovia: vložte ktorékoľvek pole z dát udalosti do URL pomocou syntaxe s dvojitými zátvorkami {{field_name}}. Príklad: example.com/postback?cid={{fbclid}}&payout={{order_total}}. Hodnoty sú URL kódované a zástupca, ktorého pole chýba, sa vyhodnotí ako prázdna hodnota. To vám umožní odoslať konverzné dáta priamo do reklamnej platformy bez proxy.
Adresa sa overuje po odstránení zástupcov, takže neplatná URL vráti "URL, ktorú ste zadali, je nesprávna".

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

Povinné, keď je typ E-mail. Musí to byť platná adresa, maximálne 127 znakov.

Úprava webhooku

Kliknutím na ktorýkoľvek riadok otvoríte editor. Každé pole je upraviteľné. Pole URL sa predvyplní iba vtedy, keď je uložený typ API, a pole e-mailu sa predvyplní iba vtedy, keď je uložený typ E-mail. Kliknutím na Uložiť zmeny použijete. Uloženie s nezaškrtnutým Aktivovať webhook deaktivuje bez jeho odstránenia.

Stĺpce zoznamu webhookov

Názov: štítok s dátumom vytvorenia.
URL / E-mail: cieľ.
Typ: API alebo E-mail.
Udalosť: Vytvorenie relácie, Vytvorenie objednávky alebo Aktualizácia objednávky.
Formát: Json.
Stav: Aktivované alebo Deaktivované.

Odstránenie webhooku

Vyberte jeden alebo viac riadkov a kliknite na Odstrániť webhooky. Odstránenie je trvalé a zastaví všetky budúce doručenia pre daný odber.

Doručenie, opätovné pokusy a e-maily o zlyhaní

Táto časť sa vzťahuje na webhooky typu API. Webhooky typu E-mail sú odošli a zabudni: odošlú sa raz bez opätovného pokusu a bez sledovania zlyhania.

Správanie opätovných pokusov

Každá požiadavka má časový limit 5 sekúnd. Ak cieľ vráti chybu 5xx, 429 (obmedzenie rýchlosti) alebo ho nemožno dosiahnuť (chyba pripojenia), doručenie sa považuje za dočasné zlyhanie a opakuje sa.
Po prvom zlyhaní doručenia Storeep opakuje s exponenciálnym oneskorením v rámci až 5 opätovných pokusov: približne o 30 s, 60 s, 120 s, 240 s, potom 480 s neskôr. Po poslednom opätovnom pokuse sa udalosť zahodí.
Odpoveď 4xx iná ako 429 (napríklad 404 alebo 403) sa považuje za trvalé zlyhanie. Storeep ju neopakuje, pretože nesprávny alebo odmietajúci koncový bod sa sám neopraví.
Keď máte viacero webhookov na rovnakej udalosti, opätovný pokus odošle znova iba tým, ktoré zlyhali. Koncové body, ktoré už vrátili úspech, sú preskočené, takže nedostanete duplicitné doručenia.

E-mail s oznámením o zlyhaní

Storeep počíta po sebe idúce zlyhané doručenia na webhook. Po 5 po sebe idúcich zlyhaniach dostane vlastník obchodu jeden e-mail s názvom "Potrebný zásah: váš webhook Storeep zlyháva", v jazyku vlastníka, s uvedením názvu webhooku, cieľa, udalosti a posledného stavového kódu HTTP.
Dostanete presne jeden e-mail na sériu zlyhaní. Žiadne ďalšie e-maily sa neodošlú, kým sa daný webhook nezotaví.
Hneď ako doručenie znova uspeje, počítadlo zlyhaní sa vynuluje a oznámenie sa znova aktivuje, takže budúca prerušená séria vám môže znova poslať e-mail.

Tipy a úskalia

Pre rovnakú udalosť môžete vytvoriť viacero webhookov, napríklad odošlite Vytvorenie objednávky ako dva samostatné záznamy do CRM aj do reklamnej platformy.
Ak váš koncový bod potrebuje autentifikáciu, vložte token do reťazca dopytu URL, buď napevno, alebo cez {{zástupcu}} z dát udalosti, alebo ho predraďte proxy, ktorá pred preposlaním pridá autentifikáciu.
Vytvorenie relácie sa spustí pre každú jedinečnú reláciu návštevníka a v rušných obchodoch môže mať veľký objem. Prihláste sa naň iba vtedy, ak váš koncový bod zvládne priepustnosť, a pamätajte, že funguje iba s typom API.