Create a Webhook
Before you start, make sure you have the following information:
-
The API User you want to assign as the owner of the webhook. Only active API users display in the list, so create one before creating the webhook.
-
The Form you are basing the webhook on (Absence When an employee or worker is absent from work. This can be for a variety of reasons., Personal or Contract).
-
The Event Type for your webhook.
-
The HTTP Method you want to use.
-
Your Payload Type.
-
Your Target URL.
-
Your Authentication Type.
-
Go to System Tools, select Utilities, then Tools, then Webhooks.
-
Select Create New to open a blank webhook creation form.
-
Select an API User to assign as the owner of the webhook. The API User determines the Set Rights Set Rights are the system permissions you allocate to employees to control the information available to a user about other employees. permissions applied to the webhook.
Only active API users are available to select. If an API user cannot be found, check its status is active. If no API users have been created yet, create one first.
-
Select the Form drop-down arrow to select your tab. You can create webhooks from the Absence, Contract and Personal tabs.
-
Choose the required Event Type from the list. Available Event Types differ according to the Form selected.
-
For your HTTP Method, select DELETE, PATCH, POST or PUT.
-
DELETE - Deletes the resource at your specified URL.
-
PATCH - Allows partial updates to a resource at your specified URL.
-
POST - Makes a POST request to a URL to create a resource at your specified URL.
-
PUT - Makes a PUT request to a URL to update a resource at your specified URL.
-
-
Choose the Payload Type, either JSON or XML. This is the format of the data you are sending.
-
Enter the Target URL (the URL address of the resource you wish to create the webhook for).
-
Choose an Authentication Type from the list.
-
Select Active to activate the webhook. (You can edit this later if you wish to pause it for a while.)