In this article

What are API Webhooks?

Webhooks allows an application to communicate with another application, sending automated messages via an HTTP request to notify others that something new has occurred.

Webhooks are often referred to as "reverse APIs" because instead of the server waiting to hear back from the client, the server-side application will call the client-side application through an end-point URL provided by the client application.


A webhook relay allows you to receive real-time updates about an event. The client no longer has to routinely poll the server, checking to see if there is new data.

How does it work?

Let's say for example you want to notify your own application when a candidate is added to an assignment you are working on. This will be the workflow:

  1. You subscribe to a new webhook in Ezekia and select 'Candidate Added to Assignment' as the event.
  2. A colleague adds a candidate to an assignment in Ezekia.
  3. The 'Candidate Added to Assignment' event is triggered and a HTTP request with the affected candidate and assignment data is immediately sent to your own application.
  4. Your application will process the data sent by the webhook from Ezekia.

Viewing list and managing subscribed API Webhooks in Ezekia


IMPORTANT!
To manage webhooks, the user must belong to the 'admins' permission group.


You can view all subscribed webhooks by navigating to "Settings", then click "Integrations" icon on the left, and then click on "Webhooks" tab.


Click on "Add new subscription" to create a new webhook.


You can pause/resume, edit and delete a webhook.

Subscribe to a new API Webhook in Ezekia


Add Webhook Main Details

1. Specify a name for the Webhook.


2. Specify the REST API URL of the third party application you want to send the payload data.


3. Select the API method - POST, PATCH or PUT. By default, Ezekia will use POST if no method is selected.


4. Choose which event you want the webhook to fire on.


5. Add any custom parameters you want to pass through. You may want to know where the webhook has come from initially, or add some other flag. You can attach them as a query parameter on the URL or added into the request body.


Add Authentication Details

Security is very important when setting up and receiving a webhook, as your company data is being sent to an external application via the internet. You can set up authentication for your webhook by selecting:

  • None - No authentication required.
  • API Key - A key/value passed through the HTTP header.
  • Bearer Authentication - A JWT is sent through as Authorization Bearer in the HTTP header.
  • Basic/Digest Authentication - A username and password is passed through the HTTP header.


Testing the Webhook within Ezekia

When setting up your webhook, you can execute a test to view the webhook's response. During the test, any authentication you have entered will be used to connect to your application.

WARNING - The test will send data to your application's endpoint. It will use data from the last event update.