Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.hirehive.com/llms.txt

Use this file to discover all available pages before exploring further.

Webhooks are a way for an application to provide real-time notifications to other systems when certain events occur. They allow you to build integrations that respond to specific events in a more efficient and scalable way than constantly polling an API for updates. In this guide, we’ll explore how to set up and implement webhooks, including establishing a webhook endpoint, configuring your webhooks, and handling webhook notifications.

​
Use cases

Webhooks can be utilized for various purposes, such as:
  • Automatically creating a new employee record in your HRIS system when an application is hired.
  • Updating the jobs on your website when a job is published.
  • Send a contract offer to the candidate when they are moved to a specified stage.

​
Webhook payload format

The request body of the webhook will contain 3 properties.
  • The type of the event, eg. job.created.
  • The timestamp the event occurred at.
  • The data property which will contain the object of the event.
{
   "type": "application.created",
   "timestamp": "2024-01-24T14:59:34.5220878Z",
   "data": {
      ....
   }
}

​
Creating a webhook

You must have the required permission to manage webhooks.
You can create an unlmited number of webhooks. A webhook can listen for a single or multiple events depending on your use case. You can enable/disable a webhook at anytime and view a log of requests sent to the webhook.