Webhooks

5 minut
Webhooks přinášejí možnost propojit platformu solidpixels s dalšími aplikacemi. Díky tomu můžete v reálném čase reagovat na události, které na vašem webu nastanou.

Propojení dat s dalšími aplikacemi

Webhooks jsou důležitou součástí pro integrace a propojení platformy solidpixels s dalšími aplikacemi. Díky tomu můžete v reálném čase reagovat na události, které na vašem webu nastanou, např. zákazník vytvoří objednávku, vyplní formulář nebo se registruje k newsletteru. Webhooks vám umožní odesílat data z vašeho webu do dalších aplikací a automatizovat mnoho procesů, které byste tradičně dělali ručně.

TIP: Získejte funkci API a Webhooks do vašeho webu

Webhooky jsou prémiovou funkcí a lze ji dokoupit jako rozšíření k vašemu webu. Pokud byste o ni měli zájem, neváhejte kontaktovat naši podporu.

Založení webhooku

Webhook je webová adresa (URL), kterou si můžete v administraci nastavit a systém podle zvolených pravidel na tuto adresu odesílá zprávy / data. V nastavení webhooku si stanovíte URL adresu, formát dat a událost, na kterou se data odešlou. O zbytek se postará systém sám. 

  1. Na záložce Nastavení > Webhooks klikněte na tlačítko „Nový záznam“.  
  2. Vyplňte název webhooku, např. „Registrace zákazníka do CRM“.
  3. Vyberte formát data. V nabídce jsou varianty JSON, Form a Query (více o formátech níže).
  4. Zvolte typ záznamu a událost, na kterou se má webhook zavolat. Např. chcete na registraci k newsletteru rovnou zákazníka přidat do svého CRM. Pak zvolíte typ záznamu „Data z formuláře“ a událost „Vytvoření záznamu“.
  5. Klikněte na tlačítko „Uložit“.
  6. Data se nezačnou odesílat okamžitě, jakmile budete připraveni na spuštění přepněte webhook do stavu „Aktivní“.

Správné nastavení záznamu si můžete ověřit kliknutím na tlačítko Poslat testovací požadavek, které ověří, že založený webhook v cílové aplikaci existuje. 

nastavení webhooku v solidpixels

Jak zvolit správný formát dat?

Všechno závisí na aplikaci, do které chcete data odesílat. Solidpixels podporuje nejrozšířenější formáty, tedy JSON a formulářová data. 

  • JSON
    • JSON je velmi rozšířený formát dat, který se snadno dále strojově  zpracovává. Pokud ho vaše cílová aplikace podporuje, doporučujeme jej použít.
  • Form
    • Formát „Form“ představuje stejný formát, jakým se odesílají formuláře.
  • Query
    • V některých okrajových případech se vám může hodit webhook ve formátu „Query“, ve kterém jsou data přibalená do samotné URL adresy, např. https://domain.com/123456?Customer=Martin.

Přehled záznamů a událostí

Následující přehled ukazuje, na které typy záznamů a událostí můžete pomocí webhooků integrovat další aplikace. Nabídka se může lišit v závislosti na dostupných modulech ve vašem plánu.

Výběrem typu záznamu se omezí události pouze pro zvolený typ. Stejně funguje omezení pomocí události. Díky tomu můžete automatizovat pouze konkrétní akce na webu, např. vytvoření objednávky v e-shopu nebo odeslání poptávkového formuláře. 

Typy záznamů

Název modulu Typ záznamu
Články Článek
Kategorie
Autoři článků
Události Událost
Osoba
Eshop Objednávka
Produkty
Kategorie
Ostatní Data z formulářů
Získané kontakty

Události

Název události
Vytvoření záznamu Událost se spustí při vytvoření záznamu v CMS nebo přes formulář na webu.
Změna záznamu Událost se spustí, pokud dojde k opětovnému uložení záznamu.
Smazání záznamu Uživatel smaže záznam v administraci.
Publikace LB Událost se sputí při publikaci záznamu s Layout Builderem.

Bezpečnost

Všechna data se standardně posílají přes zabezpečený protokol HTTPS. Pro velmi pokročilé je tu navíc možnost přidat další vrtsvu zabezpečení skrze bezpečnostní klíč.

Klíč slouží k „podepsání“ požadavku, který je odesílán z vašeho webu. Stejný klíč je pak nutné použit k ověření na straně serveru, že je přijatá zpráva autentická.

  • Klíč získáte v detailu webhooku v administraci.
  • Bezpečnostní klíč je použit k vytvoření otisku dat a tento otisk je poslán v hlavičce X-Solidpixels-Security požadavku.
  • Otisk dat (hash) je vytvořen metodou HMAC  algoritmem sha256.
Webhook bezpečnostní klíč