Fetching data...
Developer API Reference
Build powerful integrations with our platform APIs.
Fetching data...
Build powerful integrations with our platform APIs.
Build powerful integrations with our platform APIs.
Subscribe to real-time events to build reactive integrations. All webhooks are signed for security.
When an event occurs in PeopleLensAI, we send a POST request with a JSON payload to your configured URL. You should respond with a 2xx status code within 5 seconds to acknowledge receipt.
| Event Name | Description |
|---|---|
candidate.created | New candidate added |
candidate.updated | Profile fields updated |
candidate.deleted | Candidate removed |
candidate.stage_changed | Moved to new pipeline stage |
candidate.status_changed | Hired, Rejected, or Archived |
job.created | New job requirement opened |
job.updated | Job details changed |
job.closed | Job reached "closed" status |
interview.invited | Link generated for candidate |
interview.scheduled | Booking confirmed/rescheduled |
interview.decision | Decision recorded in platform |
scorecard.generated | AI assessment complete |
interview.human_scored | Manual scorecard submitted |
All outbound webhooks include a X-PeopleLens-Signature header. This is a HMAC SHA256 hash of the raw request body, signed with your Webhook Secret found in Settings.
Security Note
For inbound webhooks (like Recruitee), we recommend appending your API token as a query parameter for secure tenant resolution in production: ?api_token=YOUR_TOKEN
{
"event": "scorecard.generated",
"timestamp": "2026-02-25T14:15:00Z",
"data": {
"plan_id": "plan_abc123",
"candidate_id": "can_7788",
"overall_score": 85,
"recommendation": "strong_hire",
"scorecard_url": "https://yourapp.com/api/v1/interviews/plan_abc123/scorecard"
}
}