Webhooks - InterviewFlowAI Knowledge Base

Webhooks alert your external systems the moment a candidate takes action. Add your destination URL to subscribe to the following core events.

Set up outbound webhooks

Available webhook events

Event	Trigger	Use Case
`interview.started`	Candidate clicks the link and enters the interview lobby.	Update candidate status in your ATS to “Interviewing”.
`interview.in_progress`	Candidate actively begins answering the AI’s questions.	Track real-time engagement and drop-off rates.
`interview.completed`	The AI or candidate officially concludes the interview session.	Notify team members via Slack or email.
`interview.declined`	Candidate is marked as declined.	Stop interview follow-ups and update candidate status.
`interview.opted_out`	Candidate opts out of the interview.	Suppress future interview reminders and update consent status.
`interview.report_available`	Scoring engine finishes processing; scorecard is ready.	Trigger downstream review workflows.

Pre-launch checklist

API Key is generated and securely stored in your environment variables.
API Key is included in the header of all GET, POST, and PATCH requests.
Integration is configured for the correct, active Interviewer.
Webhook receiving endpoints are live and configured to accept POST requests.

Common mistakes to avoid

Missing headers: Forgetting to include the API key will result in 401 Unauthorized errors.
Ignoring retries: Failing to handle duplicate webhook events. Ensure your system processes webhook IDs idempotently.
Wrong Interviewer context: Pushing or fetching candidates from the wrong Interviewer ID.
Timeout failures: Webhook endpoint taking too long to respond. Always return a 200 OK status immediately before processing heavy data.

Custom Attributes: Managing Additional Fields