Event Classes ^ALPHA

event_classes are a specialized set of metadata to allow integrators to correctly classify the events that they create. They are designed to provide a common data structure that allows information to be shared between applications that leverage Cronofy’s scheduling infrastructure.

For example, an Applicant Tracking System (ATS) can classify an event as an interview, identify people in the key roles and include canonical identifiers that can be referenced. Then, a video interviewing service or extension that is also integrated with Cronofy can use this information to provide a tailored experience to participants, or access the correct interview plans.

They are added as part of the Create or Update Event payload.

Additionally they can be added through either the Create Scheduling Request or Real Time Scheduling APIs by adding the event_classes field to the event portion of the request.

{
  "event_id": "qTtZdczOccgaPncGJaCiLg",
  "summary": "Interview for Account Manager",
  ...
  "event_classes": {
    "interview": {
      "interview_id": "id-value-eg-from-the-ATS",
      "interviewers": [
        {
          "email": "doc.brown@hill-valley-science.com"
        }
      ],
      "candidates": [
        {
          "name": "Marty McFly",
          "email": "marty@hill-valley-high.com"
        }
      ]
    }
  }
}

Supported Classes #

Currently two types of event_classes are supported Interview and Sales Meeting. They in turn support a subset of objects and fields that are all optional. Fields are String values of up to 256 characters

An event can have multiple event_classes.

More will follow as we work with customers and partners to identify the key common data structures that are of use. If you would like to input, please contact us via the support team.

Interview #

The interview event class follows the following structure and fields.

{
  "interview": {
    "interview_id": "id-value-eg-from-the-ATS",
    "job_id": "id-value-eg-from-the-ATS",
    "job_name": "Account Manager",
    "employer_name": "Hill Valley Science Corp.",
    "interviewers": [
      {
        "interviewer_id": "id-value-eg-from-the-ATS",
        "email": "doc.brown@hill-valley-science.com",
        "name": "Doc Brown",
      },
      {
        "interviewer_id": "id-value-eg-from-the-ATS",
        "email": "einstein@hill-valley-science.com",
        "name": "Einstein",
      }
    ],
    "candidates": [
      {
        "candidate_id": "id-value-eg-from-the-ATS",
        "name": "Marty McFly",
        "email": "marty@hill-valley-high.com"
      }
    ]
  }
}

Sales Meeting #

The sales_meeting event class follows the following structure and fields.

{
  "sales_meeting": {
    "account_id": "id-value-eg-from-the-CRM",
    "account_name": "Biff Tannen's Pleasure Paradise Casino & Hotel"
  }
}