> ## 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 interview.

### Get your API key

An **Owner** creates the key. See [API Keys](/platform/api-keys).

1. Click **API Keys** in the sidebar.
2. Click **Generate key**.
3. Enter a clear name, such as "Zapier Integration", and click **Create key**.
4. Copy your API key and store it securely. It's shown in full only once.

### 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** and **Metadata**: Optional integration details. Ask your technical team to supply the values and JSON format if your workflow needs them.
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**: Triggers when a new Candidate is created.
   * **Interview Started**: Triggers when a Candidate starts an interview.
   * **Interview Completed**: Triggers when a Candidate completes an interview.
   * **Interview Report Available**: Triggers when an interview report 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.
* **Test with a test Candidate.** Confirm the invitation and result updates before turning on the Zap for your hiring workflow.
* **Get help with custom fields.** Ask your technical team to check any optional integration values.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.