Webhooky

Webhook slouží k posílání zpráv druhé straně v případě, kdy v Ellity nastanou různé události. Druhou stranou může být váš interní informační systém, systém pro řízení podniku, systém pro e-mailovou komunikaci, nebo obecně služba, která disponuje API. Obsah zprávy si můžete přizpůsobit dle potřeb druhé strany. Druhou stranu specifikujete URL adresou, na které strana přijímá zprávy.

Události

  • Změna konta zákazníka
  • Změna VIP úrovně zákazníka
  • Další dle požadavku klienta

Nastavení zprávy

Přejděte do Nastavení - Integrace - Webhooky. Pokud ještě nemáte přidanou funkci Webhooky, přidejte ji. Nyní můžete přidávat webhooky. Přidejte webhook a otevřete si jej.

  1. Máte možnost odesílání povolit nebo dočasně zakázat.
  2. Vyberte spouštěč, to je událost, při které se má zpráva odeslat
  3. Zadejte URL adresu druhé strany
  4. Je-li potřeba, vyplňte obsah zprávy.

Pro vývojáře

Vyplníte-li tělo zprávy, bude se posílat metodou POST. Bez vyplněného těla zprávy se bude posílat metodou GET.

URL a obsah zprávy

V URL adrese i obsahu zprávy můžete používat proměnné, které se při odesílání nahradí daty. Každá událost disponuje jinými daty. Použijete-li proměnnou, která v dané události není přítomna, pošle se prázdná hodnota (""). Proměnou zadáte ve formátu #nazev# a k dispozici máte například:

  • customer.id - id zákazníka
  • customer.email - email zákazníka
  • customer.credit - konto zákazníka
  • customer.group.id - id skupiny zákazníka
  • customer.group.name - název skupiny
  • customer.tier.id - id VIP úrovně zákazníka
  • customer.tier.name - název VIP úrovně
  • creditChange.value - hodnota změny konta
  • account.eshopId - id e-shopu
  • a další získáte stisknutím tlačítka Vložit proměnnou pod tělem zprávy (do URL musíte proměnnou napsat ručně).

Chcete-li přidat proměnnou jako parametr URL adresy vložte jej například následovně:

https://domena_druhe_strany/cesta?id=#customer.id#&email=#customer.email#
https://domena_druhe_strany/cesta/#customer.id#

Obsah zprávy je nutné napsat ve formátu JSON, zde je příklad:

{
   "eshop":"#account.eshopId#",
   "email":"#customer.email#",
   "credit":"#customer.credit#",
   "custom": {
      "field":"vlastni_pole"
   }
}

Pokud potřebujete autorizovat poslání zprávy, použijte prosím URL parametr s hodnotou API klíče. Vyžaduje-li druhá strana autentizaci přes HTTP hlavičky (Authorize apod.), kontaktujte prosím naši technickou podporu.

Pro NEvývojáře

Nastavení webhooku může být pro běžného uživatele nesnadný úkol. Nebudete-li si vědět rady, kontaktujte naši podporu, která Vám pomůže.

Integrace na míru

Přizpůsobené řešení vašich unikátních potřeb

V Ellity rozumíme, že každý podnik je jedinečný s vlastními specifickými potřebami. Proto jsme pro vás připravili službu Integrace na míru - klíčové řešení pro vaše specifické požadavky, které nemůžeme pokrýt standardními nabídkami.

Více o službě.

Odpovědělo to vaši otázku? Děkujeme za zpětnou vazbu Při odesílání zpětné vazby došlo k problému. Prosím zkuste to znovu později.