Authentication
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Request Body
Unique identifier of the webhook to update
Updated array of event types to subscribe to. An empty array [] is valid and will remove all event subscriptions. Available events: job_added job_activated job_deactivated job_deleted applicant_applied cv_upload_completed meeting_booked
Set to true to activate or false to deactivate the webhook
At least one of events or active must be provided alongside the required id field. Both can be sent together in a single request.
curl --location --request PATCH 'https://api.hirempire.com/v1/webhook' \
--header 'Authorization: Bearer YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
"id": "0c8t5e54-e053-40b2-8c9c-b45rgy0acf8a",
"active": false
}'
Response
Indicates if the webhook was updated successfully
Updated webhook details Show Data Object Properties
Unique identifier of the updated webhook
Current active status of the webhook
ISO 8601 timestamp of when the webhook was last modified
{
"success" : true ,
"data" : {
"id" : "0c8t5e54-e053-40b2-8c9c-b45rgy0acf8a" ,
"active" : false ,
"modified_at" : "2025-07-01T04:39:20.000Z"
}
}
Error Responses
Validation Errors
400 - Bad Request
{
"success" : false ,
"error" : "Field 'request_url' is required and must be a string."
}
400 - Bad Request
{
"success" : false ,
"error" : "Field 'events' is required and must be an array."
}
400 - Bad Request
{
"success" : false ,
"error" : "Invalid event: invalid_event_name."
}
400 - Bad Request
{
"success" : false ,
"error" : "Invalid token"
}
400 - Bad Request
{
"success" : false ,
"error" : "Input is incorrect."
}
400 - Bad Request
{
"success" : false ,
"error" : "Invalid request url"
}
Authorization Errors
401 - Unauthorized
{
"success" : false ,
"error" : "Token is expired"
}
401 - Unauthorized
{
"success" : false ,
"error" : "Token is missing required scope"
}
Forbidden
403 - Forbidden
{
"success" : false ,
"error" : "Token has been deleted"
}