Zkopírováno

/v1/Customer/WebHook/Create

Vytvoří nový webhook - reakci na událost ohledně zákazníků.

Nutná oprávnění

WebHooks, Customer_r

Webhooky

Detaily chování webhooků lze nalézt na této stránce: Webhooky

Požadavek

WebHookCreateRequest
Název Popis Typ Další informace
EventType

Typ události, která vyvolá webhook.

WebHookEventType

Povinný údaj

HookUrl

Url adresa, na kterou bude požadavek vykonán.

string

Povinný údaj

Tag

Vlastní označení webhooku.

string
TimeStamp

Datum a čas prováděného dotazu

unix time stamp

Příklad požadavku

application/json

Ukázka
{
  "HookUrl": "https://reservanto.cz/WebHook",
  "Tag": null,
  "EventType": "Customer_Create",
  "TimeStamp": 1769346852
}

Odpověď

Popis odpovědi

Vytvoří nový webhook - reakci na událost ohledně zákazníků.

ItemResponseOfWebHookApiModel
Název Popis Typ Další informace
Result

Navrácený objekt vyhovující dotazu.

WebHookApiModel
ErrorMessage

Chybová hláška doplňující chybu (např. pro debug).

string
ErrorMessages

Pole chybových hlášek. Pokud vznikla jen 1 chyba, tak je tu jen 1 chybová hláška.

string[]
ErrorParameter

Případný chybně zadaný parametr v požadavku.

string
ErrorParameters

Pole chybně zadaných parametrů. Pokud je chybný jen 1 parametr, tak je tu jen 1.

string[]
IsError

Indikuje, zda vznikla chyba.

boolean

Příklad odpovědi

application/json

Ukázka
{
  "Result": {
    "EventType": "Customer_Create",
    "Tag": null,
    "HookUrl": "https://reservanto.cz/WebHook",
    "Id": 14589123
  },
  "IsError": false,
  "ErrorParameter": null,
  "ErrorMessage": null,
  "ErrorParameters": [],
  "ErrorMessages": []
}