For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

API
- Getting Started
Webhooks
- Getting Started
API Reference

Getting Started
Getting Started
Webhooks
LISTING_CREATED
LISTING_UPDATED
CANDIDATE_ADDED
CANDIDATE_STAGE_UPDATED
CANDIDATE_HIRED
Listings
List listings
Get a listing
Candidates
List candidates for a listing
Get performance metrics for a listing

API Reference Webhooks

CANDIDATE_ADDED

Payload

1 {
2   "type": "string",
3   "id": "string",
4   "stage": "PRESCREENING",
5   "customStage": "string",
6   "candidate": {
7     "id": "string",
8     "firstName": "string",
9     "lastName": "string",
10     "email": "string",
11     "phone": "string",
12     "resumeUrl": "string",
13     "linkedInUserName": "string",
14     "portfolioUrl": "string"
15   },
16   "job": {
17     "id": "string",
18     "title": "string"
19   }
20 }

Was this page helpful?

CANDIDATE_STAGE_UPDATED

Headers

x-vouch-signaturestringRequired

HMAC-SHA256 signature: t=<unix timestamp>,v1=<hex hmac of "{t}.{raw body}" keyed by your webhook secret>. Reject requests older than 5 minutes.

Payload

The payload of this webhook request is an object.

type"CANDIDATE_ADDED"Required

idstringRequired

stageenumRequired

customStagestring or nullRequired

candidateobjectRequired

jobobjectRequired

Response

200

Acknowledge receipt. Any non-2xx response is retried.