Event types

Event type is represented in the type field of the event. Different event types have different payload schemas.

Below is a list of the currently-supported event types and their payload schemes. We may add more Events in the future, and potentially also additional fields, so in developing your code, be sure to build it in a way that it can support new Event types, as well as tolerate extra new/unknown fields.

candidate_import/v1

Occurs whenever a user (typically a recruiter) imports a candidate CV or profile from an external searcher. The data section contains the Candidate data in JSON format, extracted from the external source and parsed from the resume/CV. The structure of this JSON depends on the parser used and is not standardized, varying according to the specific output of the chosen parser.

Note: In the near future, this will be extended to support automatic external candidate import workflows.

Payload schema sent by webhook for a candidate_import/v1 event

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "schemas/candidate_import/v1.schema.json",
  "title": "candidate_import/v1",
  "description": "Occurs whenever a user (typically a recruiter) imports a candidate CV or profile from an external searcher.",
  "type": "object",
  "properties": {
    "data": {
      "description": "JSON containing structured Candidate data as parsed by the designated parser. The structure and content of this data will vary based on the parser used and may include elements such as name, email, address, work history, education, skills, and source.",
      "type": "object"
    },
    "binaries": {
      "description": "An optional object that contains attached binary files associated with the Candidate (for example a CV).",
      "type": "object",
      "properties": {
        "cv": {
          "$ref": "#/$defs/document"
        },
        "attachments": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/document"
          }
        }
      },
      "required": [
        "cv"
      ]
    }
  },
  "required": [
    "data"
  ],
  "$defs": {
    "document": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "The unique identifier for a binary file"
        },
        "type": {
          "type": "string",
          "description": "The type of binary file. (e.g pdf, jpg etc.)"
        }
      },
      "required": [
        "id",
        "type"
      ]
    }
  }
}

See here for information about using the UUID to retrieve the binaries associated with the event.

job_match/v1

This event is used whenever a job is matched with one or more candidates automatically. In other words, this is used for automated job-to-candidate matching.

Payload schema sent by webhook for job_match/v1

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "schemas/job_match/v1.schema.json",
  "title": "job_match/v1",
  "type": "object",
  "properties": {
    "candidates": {
      "description": "The ids of candidates that are matched",
      "type": "array",
      "items": {
        "type": "string"
      },
      "minItems": 1,
      "uniqueItems": true
    },
    "jobs": {
      "description": "Id of the job for which matches are found",
      "type": "array",
      "items": {
        "type": "string"
      },
      "minItems": 1,
      "uniqueItems": true
    },
    "properties": {
      "description": "Additional properties",
      "type": "object"
    }
  },
  "required": [
    "candidates",
    "jobs"
  ]
}

• candidates is a multi-element array containing the candidate IDs for which the job is matched.
• jobs is a single-element array containing the ID of the job for which auto-match is running.

candidate_match/v1

This event is used whenever a candidate is matched with one or more jobs automatically. In other words, this is used for automated candidate-to-job matching.

Payload schema sent by webhook for candidate_match/v1

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "schemas/candidate_match/v1.schema.json",
  "title": "candidate_match/v1",
  "type": "object",
  "properties": {
    "jobs": {
      "description": "The ids of jobs that are matched",
      "type": "array",
      "items": {
        "type": "string"
      },
      "minItems": 1,
      "uniqueItems": true
    },
    "candidates": {
      "description": "Id of the candidate for which matches are found",
      "type": "array",
      "items": {
        "type": "string"
      },
      "minItems": 1,
      "uniqueItems": true
    },
    "properties": {
      "description": "Additional properties",
      "type": "object"
    }
  },
  "required": [
    "jobs",
    "candidates"
  ]
}

• jobs is a multi-element array containing the job IDs for which the candidate is matched.
• candidates is a single-element array containing the ID of the candidate for which auto-match is running.