> ## Documentation Index
> Fetch the complete documentation index at: https://docs.interviewflowai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Zapier integration

> Automate workflows between InterviewFlowAI and thousands of other apps using Zapier webhooks and APIs.

Connect InterviewFlowAI with your favorite tools using Zapier. You can use the **InterviewFlowAI** Zapier app alongside your API key to build automated workflows.

## Send data to InterviewFlowAI (Action)

You can use Zapier to send data to InterviewFlowAI, such as creating a new candidate or inviting them to an Interviewer.

### Get your API key

1. Go to **API Keys**.
2. Click **Generate Key**.
3. Provide a descriptive name for your key based on its intended integration (e.g., "Zapier Integration").
4. Copy your API key and store it securely.

### Set up the action in Zapier

1. In your Zap, add a new action step.
2. Search for and select the **InterviewFlowAI** app.
3. In the **Action event** dropdown, choose your desired action.
   * **Invite Candidate**: Invites a candidate for screening for a selected Interviewer in InterviewFlowAI.
   * **Shortlist Candidate**: Shortlists a candidate for the AI interview for a selected Interviewer.
4. Click **Continue**.
5. Under **Account**, click **Sign in** and paste your API Key when prompted in the authentication window. Click **Continue**.
6. In the **Configure** tab, map the data from your previous Zap steps to the following fields:
   * **Interviewer**: Select the Interviewer you want to invite the candidate for.
   * **Candidate Name**: Full name of the candidate. Map this from a previous Zap step.
   * **Candidate Email**: Email address of the candidate. Map this from a previous Zap step.
   * **Additional Fields**: Enter as JSON. e.g., `{"score": "72", "source": "linkedin", "is_referred": "true"}`
   * **Metadata**: Enter as JSON. e.g., `{"externalId": "candidate_123", "phoneNumber": "+1-555-123-4567", "sendEmailAfter": 1}`
7. Click **Continue** and then **Test action** to verify the integration.

## Receive data from InterviewFlowAI (Trigger)

You can trigger a Zap whenever an event occurs in InterviewFlowAI, such as a candidate completing an interview.

1. In Zapier, click **Create Zap**.
2. For your trigger, search for and select the **InterviewFlowAI** app.
3. In the **Trigger event** dropdown, choose your desired event:
   * **Candidate Created** (`interview.created`): Triggers when a new candidate is created or added to an Interviewer in InterviewFlowAI.
   * **Interview Started** (`interview.started`): Triggers when a candidate starts an interview.
   * **Interview Completed** (`interview.completed`): Triggers when a candidate completes an interview in InterviewFlowAI.
   * **Interview Declined** (`interview.declined`): Triggers when a candidate is marked as declined.
   * **Interview Opted Out** (`interview.opted_out`): Triggers when a candidate opts out of the interview.
   * **Interview Report Available** (`interview.report_available`): Triggers when an interview report with scores and recommendations is ready.
4. Click **Continue**.
5. Under **Account**, select your connected InterviewFlowAI account or click **Sign in** to authenticate using your API key. Click **Continue**.
6. In the **Configure** tab:
   * **Interviewer**: Select the Interviewer whose events you want to listen for.
7. Click **Continue** and then **Test trigger** to confirm the connection and pull in sample data.

## Best practices

* **Keep your API key secure.** Never share it publicly or expose it as a URL query parameter.
* **Check the API reference.** Review the InterviewFlowAI API documentation for exact endpoints and required data payloads.
* **Use HTTPS.** Webhooks by Zapier automatically use HTTPS to ensure your data encrypts in transit.