Candidate

This webhook feeds data when a Candidate profile is created or updated. You can use this webhook to obtain the candidate data (along with CV/resume files) into your system and process it further if needed.

Data

Every Candidate webhook call contains the fields outlined below:

• id - candidate's unique identifier inside the idibu system
• firstname - candidate's first name
• lastname - candidate's last name
• comms_status - either applied or unsubscribed if the candidate opted out of communications
• email - candidate's email address
• background_info - field that can be populated by a consultant with their insights on the candidate
• created_by - identifies the consultant who added the candidate to the system or the original owner of the vacancy the applicant applied for
  • id - unique identifier of the company account inside the idibu system
  • profile_id - unique identifier of the user profile inside the idibu system
  • email - consultant's email address
  • firstname - consultant's first name
  • lastname - consultant's last name
  • group - identifies the group to which the user is assigned
    • id - unique identifier of the group
    • label - name of the group
  • subgroup - identifies the subgroup to which the user is assigned
    • id - unique identifier of the subgroup
    • parent_id - unique identifier of the group to which the subgroup is assigned
    • label - name of the subgroup
• creation_date - timestamp of when the candidate was originally added to the system
• source - the name of the source (e.g., a job board) of the candidate
• vacancies - identifies the vacancies for which the candidate applied
  • id - unique identifier of the vacancy inside the idibu system
  • reference - vacancy reference
  • title - vacancy title
  • status - candidate's current status against the vacancy; commonly used to filter the candidates and only process appropriate records
    • status_id - unique identifier of the ID inside the idibu system
    • status_type - either default (for system statuses) or extra (for custom statuses defined by the user)
    • label - name of the status
• attachments - lists all the files attached to the application
  • file_id - unique identifier of the file inside the idibu system
  • filename - full name and file type extension of the file
  • file_link - URL that allows downloading the file directly
  • type - type of the file (e.g., cv_doc, image, note, document, etc.)
• custom_fields - lists all the optional custom fields connected to the candidate
  • value - field's value (e.g., candidate's response to a screening question or a note added by the consultant)
  • name - name of the custom field
• payload-information
  • timestamp - the exact timestamp of when the webhook was sent
  • webhook_event - either candidate.create or candidate.update

Example webhook request

Header

Request URL: https://webhook.site/123456-abcd-7890-efgh
Request method: POST
User-Agent: Idibu-Hookshot
X-Idibu-Delivery: f38a0abc-dc1d-4e3c-bb63-dfc1acd9ce88
X-Idibu-Event: candidate.update
Content-Type: application/json

Payload

{
	"payload": {
		"id": "67890",
		"firstname": "Test",
		"lastname": "Candidate",
		"comms_status": "unknown",
		"email": "test@example.com",
		"background_info": "",
		"created_by": {
			"id": "123",
			"profile_id": "456",
			"email": "test@example.com",
			"firstname": "Test",
			"lastname": "User",
			"group": {
				"id": "789",
				"label": "Test Group"
			},
			"subgroup": {
				"id": "790",
				"parent_id": "789",
				"label": "Test Subgroup"
			}
		},
		"creation_date": "2025-08-11T13:37:00+02:00",
		"videos": [],
		"source": "Added manually",
		"vacancies": [
			{
				"id": "12345",
				"reference": "WH6-QRD",
				"title": "Job Title",
				"status": {
					"id": "1",
					"type": "default",
					"label": "Added"
				}
			}
		],
		"attachments": [
			{
				"file_id": "1234567890",
				"filename": "Test Candidate.pdf",
				"file_link": "https://v3.idibu.com/c/cloud/get-file/clientID/123/type/apptrack/file/YZhMWVhMm3ZfZGyMDI1XzA3LzY4ZDdjZi5IwNy8yMS8zMWYzODVhZDEyOTEyZmVF0YV8lMTQyY2wZGY=/id/1234567890",
				"type": "cv_doc"
			}
		],
		"custom_fields": [
			{
				"value": "No",
				"name": "Right to work?"
			},
			{
				"value": "Yes",
				"name": "Worked to targets?"
			}
		]
	},
	"payload-information": {
		"timestamp": "2025-08-11T13:39:20+02:00",
		"webhook_event": "candidate.update"
	}
}