Agenda hook

Sets the dealer's webhooks

For details on the settings, see the webhooks documentation

Agenda features

Name	Options
Supported methods	GET, PUT/POST, DELETE
Support for detail levels	✘
Support for filtering	✘
Support for full-text search	✘
Support for pagination	✘
Support for sorting	✘
Support for external identifiers	✘
Support for schemas	https://api.tipmoto.com/schemas/hook-{export|import}.{xsd|rng}
Support for ?fail-on-warning	✘
Support for dry-run	✘
Returns location	✘

Agenda elements

Machine name	Name	Type	Information	rw	P	S	➀	➁
url	Hook URL	string 255	URL address the hook should point to	✔	✔
format	Format	select	Data format in which the hook data should be sent Possible values: xml json	✔	✔
method	method	select	Method by which the data should be sent Possible values: PUT POST	✔	✔
agenda	Agenda	set	List of agendas to be watched. When watching several agendas, separate them with a comma. Possible values: moto dily prislusenstvi firma pobocka eshop uservalue kontakt	✔	✔
secKey	Security key	string 128	If secKey is set, the hook is sent with the HTTP header: X-TipMoto-SecKey: secKey	✔
penalty	Penalty in seconds	string 255	Hook penalty in seconds (after repeated failure). Read-only value, it is reset to zero when the hook is updated.

rw = writable
P = required element
S = the element can be used for filtering and sorting
➀ = included in detail level id
➁ = included in detail level summary

WRITE using GET

For compatibility with some READ clients that use only GET functions, this agenda also allows writing using the GET method.

A hook is deleted using the URL parameter: ?action=delete

A hook is written using the URL parameters: ?url=URL&agenda=AGENDA&method=METHOD&secKey=SECKEY