Webhook Request

The POST request contains a candidate's data under the following structure:

Request

Field

Type

Description

comeet_id

string

Unique candidate ID

person_uid

string

Unique ID of the person. Each person can have multiple candidate objects, each represents a separate hiring process

first_name

string

middle_name

string

last_name

string

email

string

time_created

timestamp

YYYY-MM-DDTHH:mm:ssZ

phone

string

mobile_phone

string

id_number

string

linkedin_url

string

source

object

Data about the candidate's source, NULL if the candidate doesn't have a source

source.name

string

source.type

string

One of the following:
Agency
Campus
Comeet Elastic Recruiting
Internal
Job Board
Job fairs
Other
Referrer: Compensated
Referrer: Uncompensated
Social network
Sourcing
Web

source.comeet_id

string

Unique source ID

resume

object

resume.name

string

resume.url

string

A public URL for the candidate resume. The link will expire three minutes after being delivered.

picture

object

picture.url

string

A public URL for the candidate profile picture. The link will expire 200 seconds after being delivered.

links

array

links[].url

string

files[]

array

files[].name

string

files[].url

string

files[].type

string

Only files of type "offer_letter" are supported

opening.description

opening.reason

position

object

position.comeet_id

string

Unique positions ID

position.name

string

Internal position name

position.public_name

string

Public facing name of the position, if different from position.name. If not defined then the value will be null

position.department

string

position.description

HTML

position.requirements

HTML

position.position_id

string

The position id that was set by the costumer. may also be null or empty string. Not to be confused with position.comeet_id

position.location

string

position.employment

string

poisiton.employee_type

string

Employee type, one of:
Outsource
Headcount
Intern
or null

position.seniority

string

position.hiring_manager

object

position.hiring_manager.first_name

string

position.hiring_manager.last_name

string

position.hiring_manager.email

string

position.leading_recruiter

object

position.leading_recruiter.first_name

string

position.leading_recruiter.last_name

string

position.leading_recruiter.email

string

position.custom_fields

object

Key-value pairs of public custom position category fields. Note that default fields (department, location, etc) are part of the position object

custom_fields

object

Key-value pairs of custom candidate fields

{  
  "comeet_id":"19E.98",
  "person_uid": "05.E4A",
  "first_name":"Bobby",
  "middle_name":"Robert",
  "last_name":"Chauck",
  "email":"[email protected]",
  "time_created":"2016-08-10T13:30:02Z",
  "phone":"07-4442321",
  "mobile_phone":"052-8644246",
  "id_number":"5454-2233-1",
  "linkedin_url":"https://www.linkedin.com/in/bobby-hauck-06b0735",
  "hired_date":"2016-10-16",
  "start_date":"2016-10-23",
  "source":{  
    "name":"JobmeHR",
    "type":"Agency",
    "comeet_id":"101E.27"
  },
  "resume":{  
    "name":"bobby_cv.docx",
    "url":"https://comeet-euw-qa.s3-eu-west-1.amazonaws.com/65c0a9ff2166g"
  },
  "picture":{  
    "url":"https://comeet-euw-qa.s3-eu-west-1.amazonaws.com/e43123cff1231g0"
  },
  "links":[  
    {  
      "url":"http://www.personalportfolio.com"
    }
  ],
  "files": [
    {
      "name": "Offer letter.pdf",
      "url": "https://comeet-euw-qa.s3-eu-west-1.amazonaws.com/e4376598f1231g0",
      "type": "offer_letter"
    }
  ],
  "opening": {
       "description": "For team A",
       "reason": "new"
  },
  "position":{  
    "comeet_id":"34D.98",
    "name":"Automation QA",
    "public_name": "Automation QA Engineer",
    "description": "<div>QA Automation Engineer - Remote working<br><br>We are looking for a QA Automation Engineer who is excited by the opportunity to build modern, open source software for financial institutions, government regulators, and others taking on the challenges of interoperability and financial inclusion. Here, as QA Automation Engineer, you’ll get the chance to work on something truly unique, that has real, lasting impact in real-time payments, and financial inclusion of the poor.<br><br>Our mission is to improve lives by accelerating universal access to reimagined financial services. It is our belief that technology is the key to driving this access for the most vulnerable and disadvantaged people.<br><br></div>",
    "requirements": "<ul><li>Agile software development experience (Kanban, Scrum)</li><li>Experience with testing and authoring test automation for both REST and SOAP based web services</li><li>Experience working with Selenium using page object modelling</li></ul>",
    "department":"R&D",
    "position_id": "AQA_011",
    "location": "New York",
    "employment": "Full-time",
    "employee_type": "Headcount",
    "seniority": "Senior",
    "hiring_manager":{  
      "first_name":"David",
      "last_name":"Black",
      "email":"[email protected]"
    },
    "leading_recruiter":{
      "first_name":"Brandon",
      "last_name": "Liao",
      "email":"[email protected]"
    },      
    "custom_fields":{  
      "custom field":"value",
      "custom field 2":"value 2"
    ...
    }
  },
  "custom_fields":{  
    "custom field":"value",
    "custom field 2":"value 2",
    ...
  }
}

Response

Expecting HTTP 200. In case of an error, make sure to include a clear and actionable description of the problem in the response shown to the user.