Skip to main content

Webhook Guide: What Triggers Them and What’s Included

This guide explains what triggers a webhook and what data is included in the payload.

Jazmyne Behnke avatar
Written by Jazmyne Behnke
Updated over 2 weeks ago

Webhook Trigger Events

Your webhook will automatically receive new information whenever there’s an important update to a candidate in your account. This happens when:

  • A new candidate applies to a job

  • A candidate completes their assessment

  • A candidate’s stage is changed (e.g., from “Applied” to “Interview”)

  • A tag is manually added to the candidate’s profile

Each of these actions triggers a webhook event that sends the latest candidate data to your connected system.


Understanding Webhook Payload

Each field below represents a field sent to your webhook when a new candidate applies or an update happens with a candidate in your IdealTraits account.

Basic Information Fields:

Field Name

Description

candidate_id

A unique ID number for the candidate in the IdealTraits system.

first_name

The candidate’s first name.

last_name

The candidate’s last name.

email

The candidate’s email address.

phone_no

The candidate’s phone number.

username

The candidate’s login username for their assessment.

business_id

The ID that represents your company’s IdealTraits account.

location_id

The ID of your business location that the candidate is connected to.

tag

This is a webhook field. Tells whether the update is for a New candidate just added, or an Update to an existing one.

resume

A URL link to the candidate’s resume. If blank, no resume was uploaded.

Job Field Details:

Field Name

Description

job_id

The ID of the job the candidate applied for.

source

Where the candidate came from.

job_title

The title of the job the candidate applied to. If blank, the candidate may have been added manually.

position_name

The internal name of the position this candidate is associated with in your account.

Timeline & Status Fields:

Field Name

Description

date_added

The date and time the candidate was first added to your account.

date_modified

The date and time the candidate was last updated.

status

The current stage the candidate is in (such as Assessment, Interview, Hired, etc.).

Candidate Communication, Ratings & Video Interview Fields:

Field Name

Description

candidate_tags

Any tags you’ve manually added to the candidate (ie. “Qualified”, “Needs Follow-up”). Blank means no tags have been added.

star_rate

A star rating you (or your team) gave the candidate. If blank, no rating was given.

smstext_consent

Shows if the candidate gave consent to receive text messages regarding their application:

1 = Consented,

0 = Did not consent.

video_invitedate

The date and time a video interview invitation was sent to the candidate.

video_interviewstatus

The current status of the video interview:

1 = Not started,

2 = In progress,

3 = Completed.

video_question_1

The first video interview question.

Add'l video interview questions will appear as video_question_2, video_question_3, and so on, for the number of questions being asked in the interview.

video_transcription_1

The transcript of the candidate’s response to the first question.

Add'l video interview transcripts will appear as video_transcription_2, video_transcription_3, and so on, for the number of questions answered in the interview.

Note: Transcriptions may take 15-30 minutes to generate and won’t update the payload without being triggered by an event (ie. candidates stage changes)

Assessment Fields:

Field Name

Description

test_id

The ID of the assessment the candidate is assigned to or has completed.

assessment_link

A direct link to the candidate’s assessment.A star rating you (or your team) gave the candidate. If blank, no rating was given.

current_page

The last assessment page the candidate visited.

profile_result

The candidate’s personality type result.

iq_result

The candidate’s problem-solving result type.

problem_solving_score

The candidate’s problem-solving score, out of 15.

sp_m

Represents the numerical value in the candidate’s personality index for Self-Perception: Motivation and Drive

sp_p

Represents the numerical value in the candidate’s personality index for Self-Perception: Persuasiveness

sp_s

Represents the numerical value in the candidate’s personality index for Self-Perception: Structure and Routine

sp_t

Represents the numerical value in the candidate’s personality index for Self-Perception: Thoroughness and Compliance

up_m

Represents the numerical value in the candidate’s personality index for Under Pressure: Motivation and Drive

up_p

Represents the numerical value in the candidate’s personality index for Under Pressure: Persuasiveness

up_s

Represents the numerical value in the candidate’s personality index for Under Pressure: Structure and Routine

up_t

Represents the numerical value in the candidate’s personality index for Under Pressure: Thoroughness and Compliance

op_m

Represents the numerical value in the candidate’s personality index for Others Perception: Motivation and Drive

op_p

Represents the numerical value in the candidate’s personality index for Others Perception: Persuasiveness

op_s

Represents the numerical value in the candidate’s personality index for Others Perception: Structure and Routine

op_t

Represents the numerical value in the candidate’s personality index for Others Perception: Thoroughness and Compliance

short_question_1

The first short-answer question.

Add'l short answer questions will appear as short_question_2, short_question_3, and so on, for the number of questions being asked in the assessment.

short_answer_1

The candidate’s written answer to the first short-answer question.

Add'l short answer answers will appear as short_answer_2, short_answer_3, and so on, for the number of questions being answered in the assessment.

Pre-Qualifying Question (PQQ) Fields:

Field Name

Description

pq_question_1

The actual text of the first pre-qualifying question.

Add'l PQQ questions will appear as pq_question_2, pq_question_3, and so on, for the number of questions being asked in PQQ.

pq_answer_1

The candidate’s answer to the first pre-qualifying question. If blank, the question may not have been answered based on the candidate's method of application.

Add'l PQQ answers will appear as pq_answer_2, pq_answer_3, and so on, for the number of questions being answered in PQQ.

pq_score_1

The score the candidate received for their answer (typically 0 or 10). If blank, the question may not have been scored or answered.

Add'l PQQ scores will appear as pq_score_2, pq_score_3, and so on, for the number of questions, with scoring enabled, being answered in PQQ.

Archive Fields:

Field Name

Description

archive_tag

The tag that was applied when the candidate was moved to the "Archived" stage. If blank, the candidate may not have been tagged with an archive tag, or is not in archive status.

Hired & Offer Detail Fields:

Field Name

Description

offer_createdAt

If an offer letter was sent, this shows the date and time the offer letter was created.

offer_expirydate

If an offer letter was sent, this shows when the offer will expire.

offer_signedAt

If an offer letter was sent, this shows the date and time the offer letter was signed.

hired_date

The date and time the candidate was marked as hired.

Did this answer your question?