Webhooks are a type of integration that allows information from ClearCompany to be sent to another application. This useful tool allows information from certain fields to be sent when an event happens, for example sending a candidate's name when a candidate applies to a new requisition. In this article, we cover the different supported events and the field we can send.
In this article:
What are webhooks?
Why are webhooks useful?
Supported Events
Fields Included
Setup Steps
FAQ
What are webhooks?
A webhook is a way for an app to provide other applications with real-time information. A webhook delivers data to other applications as it happens, meaning you get data immediately. ClearCompany webhooks will allow you to send the fields. Keep in mind that a webhook is static and is NOT customizable; fields CANNOT be added or deleted.
Prerequisites
In order to utilize webhooks, you must have the IT Admin Permission and Recruiting V2 must be enabled. If you are interested in this feature and do not yet have it, please reach out to your ClearCompany Representative.
Why are webhooks useful?
Webhooks are useful because they lead to less load on systems, as processing is only necessary when an event occurs. You will be able to send the information to the following applications:
- Reporting Application
- System of Record
- Dashboard for internal metric systems
- Candidate dashboard
Supported Events
| Event | Info |
|---|---|
| New Candidate(s) Created | When a new candidate is created in the system, either by manually being added, bulk added, or a candidate applies. |
| Candidate(s) Updated | When there is a change in a candidate profile in any of the fields listed below. |
| Candidate(s) Deleted | When a candidate is deleted from the ClearCompany system. |
| New Requisition(s) Created | When a user creates a new requisition. |
| Requisition(s) Updated | When the requisition fields below are updated. |
Fields Included
| Fields |
|---|
| Candidate ID |
| First Name |
| Last Name |
| Email Addresses |
| Phone Numbers (Type/Value) |
| Address Line 1 |
| Address Line 2 |
| City |
| State (Country Subdivision) |
| Country |
| Postal Code |
| Workflow |
| Requisition (ID and Name) |
| Event Date |
| Actor |
| Fields |
|---|
| Candidate ID |
| Event Date |
| Actor |
| Fields |
|---|
| Requisition ID (System Defined ID) |
| Title |
| Description |
| Status |
| Hiring Manager |
| Recruiter |
| Department |
| Office |
| Open Date |
| Closed Date |
| Custom Fields |
| Apply Process URL |
| Event Date |
| Actor |
Setup Steps
- Navigate to Tools>World of Work
- Webhooks
- Add Webhook
- You will see the fields that have to be filled out in order to complete the Webhook.
- Name: This should be an easily recognizable and friendly name. The name will be viewable from the webhook table. Example: Requisitions Created or Updated.
- Webhook URL: Add the third-party system’s endpoint where the data will be sent. The URL must be a secure endpoint containing https.
- Custom Headers: If authentication headers are required, or extra data is to be sent in the header of the request add the key and value in this section.
- Events: Select the events that will trigger the webhook. Multiple events can be selected.
- Test the webhook: Depending on the event chosen, update a field to make sure the webhook triggers to the URL.
FAQ
The "LastSuccessfulSendTimeUtc" property can help differentiate between whether or not a candidate/requisition was created or updated.
If the property value = null then the candidate/requisition was just created.
If the property value has a time stamp, e.g."2023-01-24T19:09:05Z", then we have sent information regarding this requisition/candidate in the past, and is an update.
Comments
Please sign in to leave a comment.