WebHook registration

Registration can be at the company level (Company admins can call it) or at the global level (only System admins can register a global webhook).

You can request 3 different Webhook formats:

  • URL - data is in the query string, and the call is a GET request.
  • JSON - data is formatted as a JSON payload, and the call is a POST request.
  • Form - data is formatted as a web form, and the call is a POST request.

Also, you can limit the number of called webhooks by specifying the required data:

  • All - will call the webhook in all cases
  • Payroll - will call the webhook for Payroll operations
  • Employee - you will be notified about employee changes
  • Document - you will be notified about document changes in the system
  • Client - the webhook will be called in the case of Company changes

Registration of a webhook will return a data structure with two important values:

  • id - this is the webhook ID, which can be used for testing and deleting the webhook.
  • key - this is the digital signature key used for signing data from the webhook and can be used for validation of webhook calls.