Webhooky pokladny: zasílání událostí na vzdálenou URL

Depoto umí při změně produktu, objednávky a dalších záznamů poslat zprávu na adresu vašeho systému (webhook). Nastavuje se u každé pokladny zvlášť. Článek popisuje nastavení, co přesně Depoto posílá a jak ověřit, že zprávy chodí.

Nastavení

1. V levém menu otevřete Nastavení → Pokladny a klikněte na pokladnu.
2. V části Zasílání událostí na vzdálenou URL vyplňte pole URL pro zasílání eventů. Více adres oddělte středníkem (;), každá dostane vlastní zprávu.
3. V seznamu Typy událostí zasílané na URL zaškrtněte události, které chcete dostávat. Když nezaškrtnete žádnou, posílají se všechny.
4. Pokladnu uložte.

Pokladny, které používá doplněk pro Shoptet, Shopify nebo Upgates, mají adresu a typy událostí zapsané doplňkem při prvním uložení s vybranou pokladnou. Ruční změna nebo smazání adresy přeruší přenos změn z Depota do e-shopu, proto je u takových pokladen neměňte. U Shopify lze webhooky znovu zapsat tlačítkem Registrovat webhooky.

Úprava pokladny vyžaduje oprávnění k úpravě pokladen. Bez něj se místo formuláře zobrazí „Nemáte právo pro editaci pokladny“.

Které události se posílají

• Události produktů (product.create, product.update, product.delete, product.availability) jdou do všech pokladen firmy, které je mají zapnuté.
• Události objednávek (order.create, order.update, order.delete, order.status, order.processStatus) a jejich položek (orderItem.*) jdou jen do pokladny, ke které objednávka patří.
• V seznamu jsou i události plateb, poukazů, souborů, zákazníků, skladových dokladů, výrobců, parametrů, kategorií, adres a dodavatelů.

Co Depoto posílá

Každá událost je požadavek HTTP POST s tělem ve formátu JSON (Content-Type: application/json):

{"type": "order.create", "payload": {...}, "created": {...}}

• type je typ události, created čas odeslání.
• payload obsahuje jen identifikaci záznamu, ne celý záznam. U produktu: id, ean, code, externalId, created, updated, u varianty navíc parent. U objednávky: id, status, processStatus, reservationNumber, billNumber, externalId.
• Podrobnosti si váš systém načte přes API Depota podle id, viz Napojení dat z Depota přes API (GraphQL).
• Požadavek nenese žádné přihlášení ani podpis. Pokud vaše adresa vyžaduje autorizaci, zprávy na ni neprojdou.

Doručení: jeden pokus

• Depoto každou zprávu odešle jednou a při chybě ji neopakuje. Za chybu se považuje odpověď se stavem 400 a vyšším nebo nedostupná adresa.
• Váš systém by proto neměl spoléhat jen na webhooky. Pro jistotu si změny občas dorovnejte přes API.

Jak ověřit, že zprávy chodí

• Webhook odchází jen při skutečné změně. Ve firmě bez produktů a objednávek nemá co odejít, i když je vše nastavené správně. Pro test změňte nebo založte produkt či objednávku.
• Adresa musí přijímat POST. Když ji otevřete v prohlížeči (to je požadavek GET), může vrátit chybu 404 nebo „rest_no_route“, i když funguje správně. U WordPressu je to běžné.
• Firewall nebo ochrana webu na straně příjemce nesmí požadavky z Depota blokovat.
• Pokud zprávy nedorazí ani po změně záznamu, napište podpoře adresu, pokladnu a čas změny. Neúspěšná doručení dohledáme.

Související články

• Napojení dat z Depota přes API (GraphQL)
• Pokladna: kompletní rozcestník