Integrations: Webhooks

Webhooks make it easy to tie into events that occur in the Qualified system.

Webhooks UI

Webhooks are only available on our custom plans.

Setup

Want to be notified when a candidate starts and finishes their assessment? Interested in monitoring your own team’s development of challenges and assessments?

Simply provide a URL to your API and check the boxes for the events you want to be broadcasted to this URL. Then you can integrate into your own system actions to be taken upon completion of these events.

Events

Either check the box to send all events, or choose from the list of webhook events to be notified of.

Assessment Events

These methods are specific to updates concerning assessments so they emit a Assessment in the data property.

Assessment Created - This event will fire when an assessment has been created.

Assessment Updated - This event will fire when an assessment has been updated.

Assessment Published - This event will fire when an assessment has been published. At this point it will become available for candidate usage.

Assessment Destroyed - This event will fire when an assessment has been deleted. This is a soft delete, so the assessment will in fact continue to exist should you need to reference it later.

Assessment Result Events

These methods pertain specifically to a candidate's assessment outcome so they will emit an Assessment Result in the data property.

Assessment Started - This event will fire when a candidate selects their language and begins their challenge.

Assessment Submitted - This event will fire when a candidate has completed their challenge and clicks submit. Once this has occurred, the candidate can no longer update the assessment.

Challenge Events

These methods are specific to updates concerning challenges so they emit a Challenge in the data property.

Challenge Created - This event will fire when a team member has created a new challenge. It will emit an Challenge as it's data.

Challenge Updated - This event will fire when a team member has updated a challenge.

Challenge Published - This event will fire when a challenge is published. At this point the challenge will become available for candidate usage.

Challenge Destroyed - This event will fire when a challenge is deleted. This is a permanent delete, so further references to the challenge may not be valid.

Assessment Result Review Events

These methods reference the assessment result that is a team member's evaluation of a candidate's assessment result. It will an emit an Assessment Result Review in the data property.

Assessment Result Review Created - This event will fire when an assessment result review has been created by a team member.

Assessment Result Review Updated - This event will fire when an assessment result review has been updated by a team member.

Assessment Result Review Submitted - This event will fire when an assessment result review has been submitted by a team member.

Assessment Result Review Destroyed - This event will fire when an assessment result review has been deleted. This is a permanent delete, so further references to the challenge may not be valid.

Data Models

The data sent emitted by the configured webhooks can be broken down according to their data models.

Assessment

The assessment represents the set of challenges that a candidate can be presented with.

Properties

Assessment Result

The assessment result represents a candidate's outcome after taking their challenges.

Properties

Assessment Review

The assessment review represents a team member's evaluation of a candidate's assessment result.

Properties

Challenge

Solution

Represents a candidate's attempt to solve a particular challenge.

Properties

Solution Reviews

Represents a team member's review of a particular candidate's challenge solution.

Properties

Candidate

Represents the developer taking the assessment.

Properties