Payload

The webhook payload is a JSON object with the following keys.

Key	Type	Description
`data.event`	string	The event type.
`json`	object	The payload of the webhook. See Supported Events Types for more information.
`headers.ir-signature`	string	The HMAC-SHA256 signature of the payload.

Supported Events

JobPost.Application.Submitted

Once a candidate submits an application, the webhook will send a payload with the following data:

Payload

Description

json

{
  "organization_id": "string",
  "admin_job_post_url": "string",
  "job_post_id": "string",
  "title": "string",
  "description": "string",
  "source": "string",
  "client_name": "string",
  "status": "string",
  "uuid": "string",
  "introduction_video_path": "string",
  "assignee_first_name": "string",
  "assignee_last_name": "string",
  "assignee_email_name": "string",
  "assignee_avatar_name": "string",
  "created_at": "string"
}

JobPost.Application.Completed

Once a candidate completes the interview process, the webhook will send a payload with the following data:

Payload

Description

json

{
  "interview_id": "string",
  "uuid": "string",
  "public_playback_url": "string",
  "job_post_id": "string",
  "name": "string",
  "applicant_phone_number": "string",
  "applicant_email": "string",
  "job_title": "string",
  "job_description": "string",
  "playback_url": "string",
  "status": "string",
  "created": "string",
  "applicant_status": "string",
  "overall_band_score": "string",
  "overall_band_score_description": "string",
  "is_prequalified": "boolean"
}

JobPost.Application.Status

When the status of an application changes, the webhook will send a payload with the following data:

Payload

Description

json

{
  "interview_id": "string",
  "uuid": "string",
  "public_playback_url": "string",
  "job_post_id": "string",
  "name": "string",
  "applicant_phone_number": "string",
  "applicant_email": "string",
  "job_title": "string",
  "job_description": "string",
  "playback_url": "string",
  "status": "string",
  "created": "string",
  "applicant_status": "string",
  "overall_band_score": "string",
  "overall_band_score_description": "string",
  "is_prequalified": "boolean"
}

JobPost.Publish.Status

When the status of a job post is published, the webhook will send a payload with the following data:

Payload

Description

json

{
  "organization_id": "string",
  "admin_job_post_url": "string",
  "job_post_id": "string",
  "title": "string",
  "description": "string",
  "source": "string",
  "client_name": "string",
  "status": "string",
  "uuid": "string",
  "introduction_video_path": "string",
  "assignee_first_name": "string",
  "assignee_last_name": "string",
  "assignee_email_name": "string",
  "assignee_avatar_name": "string",
  "created_at": "string"
}

JobPost.Application.Completed

Once a candidate completes the interview process, the webhook will send a payload with the following data:

Payload

Description

json

{
  "interview_id": "string",
  "uuid": "string",
  "public_playback_url": "string",
  "job_post_id": "string",
  "name": "string",
  "applicant_phone_number": "string",
  "applicant_email": "string",
  "job_title": "string",
  "job_description": "string",
  "playback_url": "string",
  "status": "string",
  "created": "string",
  "applicant_status": "string",
  "overall_band_score": "string",
  "overall_band_score_description": "string",
  "is_prequalified": "boolean"
}

Introduction

Learn how to set up webhooks for your project.

On This Page

Supported Events