Skip to main content

​
API Integration Flow

The diagram below illustrates the complete integration flow between your system, the Tidyhire platform, and the Tidyhire Interview platform.
API Integration Flow

​
How It Works

​
1. Setup (One-time)

1

Generate API Key

Log in to the Tidyhire Dashboard and generate an API key from Settings > API Keys. See Authentication for details.
2

Register Webhook

Configure a webhook URL in your Tidyhire Dashboard to receive interview results. See Webhooks for details.

​
2. Invite Candidates

From your system (ATS / LMS / In-house), use the Interview Invite API to invite candidates to an AI-powered interview. The candidate receives an email with a link to start the interview.

​
3. Interview Process

Once the candidate clicks the interview link:
  1. Candidate starts the interview on the Tidyhire Interview platform.
  2. Interview is conducted by the AI interviewer.
  3. Interview ends and scores & report links are generated.

​
4. Receive Results

After the interview is complete, the scores and report links are automatically POSTed to your configured webhook URL. Your system can then process the results and update the candidate’s status accordingly.
Last modified on February 20, 2026