Agenda hook

Nastavuje web-hooky firmy

Detailní info o nastavení viz dokumentace hooků

Funkce agendy

Název	Možnosti
Podporované metody	GET, PUT/POST, DELETE
Podpora úrovně detailu	✘
Podpora filtrace	✘
Podpora fulltextu	✘
Podpora stránkování	✘
Podpora řazení	✘
Podpora externích identifikátorů	✘
Podpora schémat	https://api.tipmoto.com/schemas/hook-{export|import}.{xsd|rng}
Podpora ?fail-on-warning	✘
Podpora dry-run	✘
Vrací location	✘

Položky agendy

Str. název	Název	Typ	Informace	rw	P	S	➀	➁
url	URL hooku	string 255	URL adresa, kam se má hook odkazovat	✔	✔
format	Formát	select	Formát dat, ve kterém mají být data hooku zasílána Možné hodnoty: xml json	✔	✔
method	Metoda	select	Metoda, kterou mají být data zasílána Možné hodnoty: PUT POST	✔	✔
agenda	Agenda	set	Seznam agend, které mají být sledovány. V případě sledování více agend oddělte tyto čárkou. Možné hodnoty: moto dily prislusenstvi firma pobocka eshop uservalue kontakt	✔	✔
secKey	Klíč zabezpečení	string 128	Bude-li uveden secKey, pošle se hook s HTTP hlavičkou: X-TipMoto-SecKey: secKey	✔
penalty	Penalizace ve vteřinách	string 255	Penalizace hooku ve vteřinách (při opakovaném neúspěchu). Hodnota pouze pro čtení, při aktualizaci hooku se vynuluje!

rw = lze zapisovat
P = povinná položka
S = dle položky lze filtrovat a řadit
➀ = je v detailu id
➁ = je v detailu summary

WRITE pomocí GET

Z důvodu kompatibility pro některé READ klienty využívající pouze GET funkce umožňuje tato agenda zápis i pomocí metody GET!

Smazání hooku je pomocí URL parametru: ?action=delete

Zápis hooku je pomocí URL parametrů: ?url=URL&agenda=AGENDA&method=METHOD&secKey=SECKEY