---
title: "Zapier"
description: "New lead, handoff requested and unanswered-question triggers, connected with an API key."
source: https://hiy.ai/docs/zapier
---

# Zapier

Start a Zap when a lead arrives, a chat is handed over or a question goes unanswered, or ask your agent a question from any Zap. No code needed.

Zapier is on Growth. On Free and Starter it is locked, with a link to your plans.

**Note:** The hiy app isn't in Zapier's directory yet, so searching Zapier for **hiy** finds nothing today. It is also rolling out to selected workspaces first: ask at [hello@hiy.ai](mailto:hello@hiy.ai) to be added early. For simpler rules inside hiy, see [Automations](/docs/automations).

## Set it up

1. **Create an API key** — Open **Workspace › Developers › API keys**, name a key "Zapier" and copy it. See [API keys](/docs/api-keys). ![The API keys list with one key named Zapier, showing only its first characters](https://hiy.ai/docs-shots/api-keys/list.webp) *Workspace › Developers › API keys*

2. **Start a Zap with hiy** — In Zapier, pick one of the triggers below, or add **Ask the Agent** as a step.

3. **Connect your account** — Paste your API key when Zapier asks. Its **Test** step lists your agents to confirm the key works.

4. **Choose the agent** — Pick the agent to watch or ask from the list. **Ask the Agent** works with Support and Team Agents. An agent of any other kind can start a Zap, but it doesn't answer one.

5. **Finish the Zap** — Add what should happen in your other app: a row in a sheet, a Slack message, a card on a board.

## Triggers

- **New Lead** (`event`) — Someone left their contact details, whether or not the chat was handed over. Event name `lead_captured`.
- **Handoff Requested** (`event`) — A chat was handed over to you. It carries the same contact details, plus whether your agent had already said it didn't know something. Event name `handoff`.
- **Unanswered Question** (`event`) — Your agent couldn't answer something new. Fires once per new question, never again for a repeat. Event name `gap_opened`.

hiy sends each event to Zapier the moment it happens. If a Zap can't receive it that way, Zapier checks hiy every few minutes instead. Zapier handles the switch for you.

## Actions

- **Ask the Agent** (`action`) — Send a question to one of your agents from a Zap (a form, a Slack message, a new row) and get back the answer and its sources. Each question is asked fresh, with no memory of earlier ones, and counts as one message on your plan, like a visitor's.

If your agent can't answer, the question lands in the **Teach queue** like any other.

**Good to know:**

- One API key can ask one agent 100 questions a day.
- Only a live, approved agent answers. A draft, or one still awaiting review, answers as if it isn't there.
- A paused workspace, or a plan that has used its messages, refuses Zapier the same way it refuses a visitor.
- With [masking](/docs/masking) on, the conversation sent to Zapier is the masked text. The lead's contact details are sent as given.
- Zapier's calls count against your key's limits a minute, the same as the API's: see [API keys](/docs/api-keys).

## Related

- [API keys](/docs/api-keys) — Keys that connect hiy to other tools: where to find them, create one, revoke one.

- [Automations](/docs/automations) — Rules that run after a handover or a new lead, for all your agents or the ones you pick.
