Skip to main content

Vacancy

This webhook feeds data whenever a Vacancy is created or updated. You can use this webhook to sync vacancies created in idibu with your system, collect data on them, and track any changes made.

Data​

Every webhook payload contains the following data:

  • id - vacancy's unique identifier inside the idibu system
  • title - vacancy title
  • status - whether the vacancy is active or not
  • search_keywords - phrase used for the vacancy's initial Local search
  • location - location of the job
    • place - the detailed location, including the place name, county/state/region/area, etc., and country
    • lat - latitude
    • lng - longitude
  • country - 2-letter ISO country code
  • job_type - type of the job
    • label - name of the job type
    • id - numeric Type ID
  • duration - contract duration, only available for Contract and Temporary
  • reference - vacancy reference
    • Caution: If idibu users create multiple adverts connected to the vacancy, their references will come with numbered suffixes (-1, -2, and so on); these suffixes will most likely need to be ignored when identifying the vacancy in your system.
  • start_date - timestamp of when the job starts
  • salary - remuneration info
    • currency - 3-letter ISO currency code
    • salary_min - minimum salary
    • salary_max - maximum salary
    • salary_per - salary period - can be either annum, month, week, day, or hour
  • salary_override - if present, will replace the salary info on most job boards
  • benefits - extra benefits aside from the salary
  • description - full description of the vacancy
  • creation_date - timestamp of when the vacancy was created in the system
  • created_by - identifies the original owner of the vacancy
    • 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
  • sector - category of the job
    • id - numeric Sector ID
    • label - name of the category
  • applr - only present if active for the account; refer to this article
    • landing_page - application page used for the vacancy
      • id - unique numeric identifier of the page
      • label - name of the page
  • payload-information
    • timestamp - the exact timestamp of when the webhook was sent
    • webhook_event - either vacancy.create or vacancy.update

Example webhook request​

Headers​

Request URL: https://webhook.site/123456-abcd-7890-efgh
Request method: POST
User-Agent: Idibu-Hookshot
X-Idibu-Delivery: 49da521a-c172-4819-b69a-89f59fa3cef1
X-Idibu-Event: update.vacancy
X-Idibu-Signature: 3858a58a3a1d4f9de79588603039432a47d9c144ab15ef0c7bc027bc4ef435daca8faab039e5cc977cf001e8598c827c50430431df0cb08b2ef9744e98e65225
Content-Type: application/json

Payload​

{
"payload": {
"id": "12345",
"title": "Job Title",
"status": "active",
"search_keywords": "\"test\" OR \"search\"",
"location": {
"place": "London",
"lat": "51.5075",
"lng": "-0.127883"
},
"country": "GB",
"job_type": {
"label": "Contract / Fulltime",
"id": "3"
},
"duration": "1 month",
"reference": "WH6-QRD",
"start_date": "2025-05-01T00:00:00+01:00",
"salary": {
"currency": "USD",
"salary_min": "12.34",
"salary_max": "56.78",
"salary_per": "hour"
},
"salary_override": "Textual salary override",
"benefits": "Job benefits",
"description": "Job<br/>Description",
"creation_date": "2025-04-02T21:37:00+02:00",
"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"
}
},
"sector": {
"id": "17",
"label": "HR & Personnel"
},
"applr": {
"landing_page": {
"id": "1234",
"label": "Basic application page"
}
}
},
"payload-information": {
"timestamp": "2025-04-02T21:38:50+02:00",
"webhook_event": "vacancy.create"
}
}