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

LISTING_UPDATED

Payload

1 {
2   "type": "string",
3   "id": "string",
4   "title": "string",
5   "status": "DRAFT",
6   "updatedAt": "2024-01-15T09:30:00Z"
7 }

Was this page helpful?

CANDIDATE_ADDED

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"LISTING_UPDATED"Required

idstringRequired

titlestringRequired

statusenum or nullRequired

updatedAtdatetimeRequired

Response

200

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