# HYROS Installation: CallRail

## REQUIREMENTS - Collect Before Starting

| Item | Ask User |
|------|----------|
| HYROS API Key | "Please paste your HYROS API key. Get it from: https://app.hyros.com/settings/api" |
| CallRail Admin Access | "Do you have CallRail admin access?" |
| Company/Account | "Which CallRail company are you setting up?" |

**IMPORTANT:** Store the API key for later use.

---

## STEPS

### Step 1: Open HYROS Integrations

**Direct URL:** https://app.hyros.com/integrations

**If automating:** Navigate to integrations page, find CallRail card.

**If guiding user:** "Go to https://app.hyros.com/integrations"

→ Confirm: "Are you on the integrations page?"

---

### Step 2: Connect CallRail

**If automating:** Find CallRail card, click Connect.

**If guiding user:** "Find CallRail and click Connect"

→ Confirm: "Did the connection setup start?"

---

### Step 3: Get API Key from CallRail

**Direct URL:** https://app.callrail.com/

**If automating:** Navigate to CallRail → Settings → API Access. Generate or copy API key.

**If guiding user:**
"Go to CallRail → Settings → API Access
Generate a new API key or copy an existing one"

→ Confirm: "Do you have the CallRail API key?"

---

### Step 4: Enter API Key in HYROS

**If automating:** Paste the CallRail API key into HYROS.

**If guiding user:** "Enter your CallRail API key in HYROS"

→ Confirm: "Did you enter the API key?"

---

### Step 5: Configure Webhook in CallRail

**If automating:** Navigate to CallRail → Settings → Webhooks. Add HYROS webhook URL for call events.

**If guiding user:**
"In CallRail:
1. Go to Settings → Webhooks
2. Add a new webhook with the URL HYROS provides
3. Select events: Incoming Call, Outgoing Call, Call Completed"

→ Confirm: "Did you configure the webhook?"

---

### Step 6: Verify Connection in HYROS

**Direct URL:** https://app.hyros.com/integrations

**If automating:** Check CallRail shows as connected.

**If guiding user:** "Verify CallRail shows as connected in HYROS"

→ Confirm: "Does CallRail show as connected?"

---

### Step 7: Test with a Call

**If automating:** Make a test call through a tracked number and verify it appears in HYROS.

**If guiding user:** "Make a test call through one of your tracked numbers and check HYROS for the data"

→ Confirm: "Can you see CallRail calls in HYROS?"

---

## TROUBLESHOOTING

- **Invalid API key:** Make sure you copied the full key from CallRail
- **Calls not showing:** Check webhook is configured and active
- **Wrong company:** Ensure you're tracking the correct CallRail company

---

## Source
Synced from: docsContent.ts (callrailGuide)
Last synced: 2026-01-03