Praxicraft Assess API for Technical Hiring

HTTPS destinations receive a signed JSON envelope; Slack and Teams destinations get a formatted chat card instead; see Slack and Teams. Register events with POST /webhooks/create/ (events array). Verify X-Praxicraft-Signature before parsing. SDK helpers. Setup overview: Webhooks.

Envelope

Every HTTPS delivery looks like this:

{
 "id": "evt_a1b2c3d4e5f6789012345678abcdef01",
 "event": "candidate.passed",
 "created_at": "2026-08-25T12:34:56.789012+00:00",
 "data": {}
}

Field	Type	Notes
`id`	string	Delivery event id (`evt_…`). Deduplicate on this.
`event`	string	Event name from the catalog below.
`created_at`	string	ISO-8601 timestamp (UTC).
`data`	object	Event-specific fields (samples below).

Header on every HTTPS delivery:

X-Praxicraft-Signature: sha256=<hex>

Live destinations only receive live events. Use a Test-mode destination (or ct_test_ key) while debugging.

Correlation fields

Assessment completion / pass-fail payloads include:

Field	When
`invite_token`	Always when the session is tied to an invitation (ATS join key).
`external_id`	Only when you set `external_id` on the invite (your ATS candidate id).

Assessment

`assessment.started`

Candidate begins a session.

{
 "id": "evt_11111111111111111111111111111111",
 "event": "assessment.started",
 "created_at": "2026-08-25T12:00:00.000000+00:00",
 "data": {
 "session_id": "550e8400-e29b-41d4-a716-446655440001",
 "assessment_id": "550e8400-e29b-41d4-a716-446655440010",
 "assessment_title": "Backend screen",
 "assessment_slug": "backend-screen",
 "candidate_email": "[email protected]",
 "candidate_name": "Ada Lovelace",
 "started_at": "2026-08-25T12:00:00.000000+00:00"
 }
}

`assessment.completed`

Candidate submitted (or timer finalized) the assessment. Scores may still be calculating. use candidate.passed / candidate.failed for scored outcomes.

{
 "id": "evt_22222222222222222222222222222222",
 "event": "assessment.completed",
 "created_at": "2026-08-25T12:45:00.000000+00:00",
 "data": {
 "session_id": "550e8400-e29b-41d4-a716-446655440001",
 "assessment_id": "550e8400-e29b-41d4-a716-446655440010",
 "assessment_slug": "backend-screen",
 "candidate_email": "[email protected]",
 "candidate_name": "Ada Lovelace",
 "invite_token": "inv_tok_abc123",
 "external_id": "gh_cand_42"
 }
}

external_id is omitted when not set on the invitation.

`candidate.passed`

Score meets or exceeds the assessment passing threshold (after grading).

{
 "id": "evt_33333333333333333333333333333333",
 "event": "candidate.passed",
 "created_at": "2026-08-25T12:46:10.000000+00:00",
 "data": {
 "session_id": "550e8400-e29b-41d4-a716-446655440001",
 "assessment_id": "550e8400-e29b-41d4-a716-446655440010",
 "assessment_slug": "backend-screen",
 "candidate_email": "[email protected]",
 "candidate_name": "Ada Lovelace",
 "score": 82,
 "max_score": 100,
 "passed": true,
 "invite_token": "inv_tok_abc123",
 "external_id": "gh_cand_42"
 }
}

`candidate.failed`

Same data shape as candidate.passed, with passed: false and a failing score.

{
 "id": "evt_44444444444444444444444444444444",
 "event": "candidate.failed",
 "created_at": "2026-08-25T12:46:10.000000+00:00",
 "data": {
 "session_id": "550e8400-e29b-41d4-a716-446655440001",
 "assessment_id": "550e8400-e29b-41d4-a716-446655440010",
 "assessment_slug": "backend-screen",
 "candidate_email": "[email protected]",
 "candidate_name": "Ada Lovelace",
 "score": 41,
 "max_score": 100,
 "passed": false,
 "invite_token": "inv_tok_abc123",
 "external_id": "gh_cand_42"
 }
}

`candidate.violation`

Proctoring signal recorded (fullscreen exit, copy/paste, screen share, webcam, or focus loss).

{
 "id": "evt_55555555555555555555555555555555",
 "event": "candidate.violation",
 "created_at": "2026-08-25T12:20:00.000000+00:00",
 "data": {
 "session_id": "550e8400-e29b-41d4-a716-446655440001",
 "assessment_id": "550e8400-e29b-41d4-a716-446655440010",
 "assessment_slug": "backend-screen",
 "candidate_email": "[email protected]",
 "candidate_name": "Ada Lovelace",
 "violation_type": "fullscreen",
 "occurred_at": "2026-08-25T12:20:00.000000+00:00",
 "task_order": 1,
 "violation_counts": {
 "fullscreen": 1,
 "copy_paste": 0,
 "screen_share": 0,
 "webcam": 0,
 "focus_loss": 0
 },
 "fullscreen_violations": 1,
 "copy_paste_violations": 0,
 "screen_share_violations": 0,
 "webcam_violations": 0,
 "focus_loss_violations": 0
 }
}

Invitation

`invitation.created`

A new assessment invitation was created (email may or may not have been sent).

{
 "id": "evt_66666666666666666666666666666666",
 "event": "invitation.created",
 "created_at": "2026-08-25T11:00:00.000000+00:00",
 "data": {
 "invitation_id": "550e8400-e29b-41d4-a716-446655440020",
 "invite_token": "inv_tok_abc123",
 "email": "[email protected]",
 "candidate_email": "[email protected]",
 "candidate_name": "Ada Lovelace",
 "assessment_id": "550e8400-e29b-41d4-a716-446655440010",
 "assessment_slug": "backend-screen",
 "assessment_title": "Backend screen",
 "status": "pending",
 "livemode": true,
 "expires_at": "2026-09-01T11:00:00.000000+00:00",
 "enrollment_id": "550e8400-e29b-41d4-a716-446655440030",
 "pipeline_enrollment_id": "550e8400-e29b-41d4-a716-446655440030"
 }
}

enrollment_id / pipeline_enrollment_id appear only when the invite was created through a pipeline enrollment.

`invitation.expired`

Pending invitation expired before the candidate started.

{
 "id": "evt_77777777777777777777777777777777",
 "event": "invitation.expired",
 "created_at": "2026-09-01T11:05:00.000000+00:00",
 "data": {
 "invitation_id": "550e8400-e29b-41d4-a716-446655440020",
 "assessment_id": "550e8400-e29b-41d4-a716-446655440010",
 "assessment_slug": "backend-screen",
 "candidate_email": "[email protected]",
 "expired_at": "2026-09-01T11:05:00.000000+00:00"
 }
}

Pipeline

Shared enrollment fields (pipeline.enrolled, pipeline.completed, pipeline.rejected, pipeline.held, pipeline.unheld):

{
 "enrollment_id": "550e8400-e29b-41d4-a716-446655440030",
 "livemode": true,
 "pipeline_id": "550e8400-e29b-41d4-a716-446655440040",
 "pipeline_slug": "eng-funnel",
 "email": "[email protected]",
 "candidate_name": "Ada Lovelace",
 "status": "active",
 "current_stage": 1,
 "rejected_at_stage": null,
 "reject_reason": ""
}

`pipeline.enrolled`

{
 "id": "evt_88888888888888888888888888888888",
 "event": "pipeline.enrolled",
 "created_at": "2026-08-25T10:00:00.000000+00:00",
 "data": {
 "enrollment_id": "550e8400-e29b-41d4-a716-446655440030",
 "livemode": true,
 "pipeline_id": "550e8400-e29b-41d4-a716-446655440040",
 "pipeline_slug": "eng-funnel",
 "email": "[email protected]",
 "candidate_name": "Ada Lovelace",
 "status": "active",
 "current_stage": 1,
 "rejected_at_stage": null,
 "reject_reason": ""
 }
}

`pipeline.advanced`

Enrollment moved to a later stage. Includes from_stage, to_stage, and next_stage_type.

{
 "id": "evt_99999999999999999999999999999999",
 "event": "pipeline.advanced",
 "created_at": "2026-08-25T13:00:00.000000+00:00",
 "data": {
 "enrollment_id": "550e8400-e29b-41d4-a716-446655440030",
 "livemode": true,
 "pipeline_id": "550e8400-e29b-41d4-a716-446655440040",
 "pipeline_slug": "eng-funnel",
 "email": "[email protected]",
 "candidate_name": "Ada Lovelace",
 "status": "active",
 "current_stage": 2,
 "rejected_at_stage": null,
 "reject_reason": "",
 "from_stage": 1,
 "to_stage": 2,
 "next_stage_type": "interview"
 }
}

`pipeline.completed`

Enrollment status became passed.

{
 "id": "evt_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
 "event": "pipeline.completed",
 "created_at": "2026-08-25T15:00:00.000000+00:00",
 "data": {
 "enrollment_id": "550e8400-e29b-41d4-a716-446655440030",
 "livemode": true,
 "pipeline_id": "550e8400-e29b-41d4-a716-446655440040",
 "pipeline_slug": "eng-funnel",
 "email": "[email protected]",
 "candidate_name": "Ada Lovelace",
 "status": "passed",
 "current_stage": 3,
 "rejected_at_stage": null,
 "reject_reason": ""
 }
}

`pipeline.rejected`

{
 "id": "evt_bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
 "event": "pipeline.rejected",
 "created_at": "2026-08-25T15:00:00.000000+00:00",
 "data": {
 "enrollment_id": "550e8400-e29b-41d4-a716-446655440030",
 "livemode": true,
 "pipeline_id": "550e8400-e29b-41d4-a716-446655440040",
 "pipeline_slug": "eng-funnel",
 "email": "[email protected]",
 "candidate_name": "Ada Lovelace",
 "status": "rejected",
 "current_stage": 2,
 "rejected_at_stage": 2,
 "reject_reason": "Failed screen"
 }
}

`pipeline.held` / `pipeline.unheld`

Same shared enrollment fields. On hold, status is on_hold. After unhold, status returns to active (or another terminal status if catch-up applied).

{
 "id": "evt_cccccccccccccccccccccccccccccccc",
 "event": "pipeline.held",
 "created_at": "2026-08-25T14:00:00.000000+00:00",
 "data": {
 "enrollment_id": "550e8400-e29b-41d4-a716-446655440030",
 "livemode": true,
 "pipeline_id": "550e8400-e29b-41d4-a716-446655440040",
 "pipeline_slug": "eng-funnel",
 "email": "[email protected]",
 "candidate_name": "Ada Lovelace",
 "status": "on_hold",
 "current_stage": 2,
 "rejected_at_stage": null,
 "reject_reason": ""
 }
}

Interview

Shared interview room fields:

Field	Notes
`interview_id`	Room UUID
`title`	Room title
`status`	Room status string
`interview_type` / `interviewer_mode`	Product mode flags
`candidate_email` / `candidate_name`	Candidate identity
`scheduled_at` / `started_at` / `ended_at`	ISO-8601 or `null`
`livemode`	boolean
`pipeline_enrollment_id`	Present when the room is tied to a pipeline stage

`interview.scheduled`

{
 "id": "evt_dddddddddddddddddddddddddddddddd",
 "event": "interview.scheduled",
 "created_at": "2026-08-25T09:00:00.000000+00:00",
 "data": {
 "interview_id": "550e8400-e29b-41d4-a716-446655440050",
 "title": "AI screen. Ada",
 "status": "scheduled",
 "interview_type": "ai",
 "interviewer_mode": "ai",
 "candidate_email": "[email protected]",
 "candidate_name": "Ada Lovelace",
 "scheduled_at": "2026-08-26T15:00:00.000000+00:00",
 "started_at": null,
 "ended_at": null,
 "livemode": true,
 "pipeline_enrollment_id": "550e8400-e29b-41d4-a716-446655440030"
 }
}

`interview.started`

Same shape; status reflects in-progress, started_at set.

`interview.completed`

Same shape; ended_at set after a normal finish.

`interview.cancelled`

Same shape; room cancelled by recruiter or API.

`interview.no_show`

Same shape; interview expired without completion.

`interview.analysis_ready`

Room fields plus analysis summary:

{
 "id": "evt_eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee",
 "event": "interview.analysis_ready",
 "created_at": "2026-08-26T16:10:00.000000+00:00",
 "data": {
 "interview_id": "550e8400-e29b-41d4-a716-446655440050",
 "title": "AI screen. Ada",
 "status": "completed",
 "interview_type": "ai",
 "interviewer_mode": "ai",
 "candidate_email": "[email protected]",
 "candidate_name": "Ada Lovelace",
 "scheduled_at": "2026-08-26T15:00:00.000000+00:00",
 "started_at": "2026-08-26T15:02:00.000000+00:00",
 "ended_at": "2026-08-26T15:45:00.000000+00:00",
 "livemode": true,
 "pipeline_enrollment_id": "550e8400-e29b-41d4-a716-446655440030",
 "overall_score": 78,
 "hire_recommendation": "lean_hire",
 "report_status": "ready"
 }
}

System

`webhook.test`

Connectivity ping from POST /webhooks/{id}/test/ (or health probes).

{
 "id": "evt_ffffffffffffffffffffffffffffffff",
 "event": "webhook.test",
 "created_at": "2026-08-25T08:00:00.000000+00:00",
 "data": {
 "message": "Praxicraft Assess webhook test",
 "test_id": "a1b2c3d4"
 }
}

HTTP 2xx on this ping sets is_verified and activates the destination.

Quick reference

Event	Primary use
`assessment.started`	Candidate began
`assessment.completed`	Submitted / timed out (pre-score)
`candidate.passed`	Scored pass. ATS score-back
`candidate.failed`	Scored fail. ATS score-back
`candidate.violation`	Integrity signal
`invitation.created`	Invite issued
`invitation.expired`	Unused invite expired
`pipeline.enrolled`	Funnel entry
`pipeline.advanced`	Stage change
`pipeline.completed`	Funnel pass
`pipeline.rejected`	Funnel reject
`pipeline.held` / `unheld`	Pause / resume auto-advance
`interview.*`	Live interview lifecycle
`interview.analysis_ready`	Report ready
`webhook.test`	Destination ping

Webhooks setup · Verify signatures · Connect ATS via webhooks · n8n · Zapier

Get started

Assessments & candidates

Interviews & webhooks

Content & pipelines

Account & reference

Webhook events

Envelope

Correlation fields

Assessment

`assessment.started`

`assessment.completed`

`candidate.passed`

`candidate.failed`

`candidate.violation`

Invitation

`invitation.created`

`invitation.expired`

Pipeline

`pipeline.enrolled`

`pipeline.advanced`

`pipeline.completed`

`pipeline.rejected`

`pipeline.held` / `pipeline.unheld`

Interview

`interview.scheduled`

`interview.started`

`interview.completed`

`interview.cancelled`

`interview.no_show`

`interview.analysis_ready`

System

`webhook.test`

Quick reference

Next

​Envelope

​Correlation fields

​Assessment

​assessment.started

​assessment.completed

​candidate.passed

​candidate.failed

​candidate.violation

​Invitation

​invitation.created

​invitation.expired

​Pipeline

​pipeline.enrolled

​pipeline.advanced

​pipeline.completed

​pipeline.rejected

​pipeline.held / pipeline.unheld

​Interview

​interview.scheduled

​interview.started

​interview.completed

​interview.cancelled

​interview.no_show

​interview.analysis_ready

​System

​webhook.test

​Quick reference

​Next

Envelope

Correlation fields

Assessment

`assessment.started`

`assessment.completed`

`candidate.passed`

`candidate.failed`

`candidate.violation`

Invitation

`invitation.created`

`invitation.expired`

Pipeline

`pipeline.enrolled`

`pipeline.advanced`

`pipeline.completed`

`pipeline.rejected`

`pipeline.held` / `pipeline.unheld`

Interview

`interview.scheduled`

`interview.started`

`interview.completed`

`interview.cancelled`

`interview.no_show`

`interview.analysis_ready`

System

`webhook.test`

Quick reference

Next