Skip to content

Workflow documentation #453

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 32 commits into from
Jun 1, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
554aec0
feat: add phone support agent workflow example
goosewin May 26, 2025
4769ff0
feat: update navigation to link new customer support hotline example
goosewin May 26, 2025
44ab9ad
feat: add screenshots for customer support hotline example
goosewin May 26, 2025
a6c90a6
fix: customer support hotline intro paragraph
goosewin May 26, 2025
e7f9bf0
fix(customer-support-hotline): image URLs
goosewin May 26, 2025
e9ad9e1
fix(customer-support-hotline): remove broken link from outro
goosewin May 26, 2025
6a69671
chore (customer-support-hotline): refine copy, add videos
goosewin May 26, 2025
07ced34
chore(customer-support-hotline): delete unnecessary screenshots
goosewin May 26, 2025
d9f31a0
fix(customer-support-hotline): slug
goosewin May 26, 2025
568958d
feat(appointment-scheduling): initial commit
goosewin May 26, 2025
69221a1
feat(banking-customer-support): update example to cover a banking use…
goosewin May 26, 2025
77aaefd
Merge branch 'main' into feature/customer-support-hotline-example
goosewin May 26, 2025
721c0b3
chore(inbound-support): address review feedback, fix system prompt
goosewin May 26, 2025
b1afd64
Merge branch 'feature/customer-support-hotline-example' into feature/…
goosewin May 26, 2025
35d4096
feat(appointment-scheduling): new workflow example
goosewin May 28, 2025
20676bc
feat(clinic-triage-scheduling): new workflow example
goosewin May 28, 2025
99d9ed0
feat(ecommerce-order-management): new workflow example
goosewin May 28, 2025
35e858b
feat(outbound-sales): new workflow example
goosewin May 28, 2025
cffa8e6
chore: delete pizza example
goosewin May 28, 2025
d87d303
fix: broken video URLs
goosewin May 28, 2025
75b3387
chore: update navigation to include new workflow examples
goosewin May 28, 2025
aa45fae
fix(inbound-support): broken video URL
goosewin May 28, 2025
6515261
chore: update `overview.mdx` to display new examples
goosewin May 28, 2025
40ac27a
feat(call-forwarding): update doc to incentivize use of dashboard
goosewin May 28, 2025
f77e415
feat(using-query-tool): update doc to incentivize use of dashboard
goosewin May 28, 2025
11a6198
feat(custom-tools): update doc to incentivize use of dashboard
goosewin May 28, 2025
6f43a80
Merge branch 'main' into feature/workflow-examples
goosewin May 30, 2025
68a902f
feat(workflows/overview): add doc
goosewin May 30, 2025
f865d93
feat(workflows/quickstart): add doc
goosewin May 30, 2025
372f490
feat(workflows): move docs, add new videos
goosewin May 30, 2025
67b61a9
chore: update nav to include workflow docs
goosewin May 30, 2025
46a4cd0
Merge branch 'main' into feature/workflows
goosewin Jun 1, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions fern/call-forwarding.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,21 @@ Vapi's call forwarding functionality allows you to redirect calls to different p

## Setting Up Call Forwarding

### 1. Defining Destinations and Messages
### 1. Create a Transfer Call Tool in the Dashboard

The `transferCall` tool includes a list of destinations and corresponding messages to notify the caller:
The recommended approach is to create your transfer call tool in the Vapi dashboard:

1. Navigate to **Tools** in your Vapi dashboard
2. Click **Create Tool**
3. Select **Transfer Call** as the tool type
4. Configure your destinations:
- **Department A**: `+1234567890` with message "I am forwarding your call to Department A. Please stay on the line."
- **Department B**: `+0987654321` with message "I am forwarding your call to Department B. Please stay on the line."
- **Department C**: `+1122334455` with message "I am forwarding your call to Department C. Please stay on the line."

### 2. Alternative: API Configuration

You can also define the tool via API with destinations and corresponding messages:

```json
{
Expand Down Expand Up @@ -112,7 +124,7 @@ You can also specify the `extension` parameter to forward the call to an extensi
]
```

### 2. Using the `transferCall` Function
### 3. Using the `transferCall` Function

When the assistant needs to forward a call, it uses the `transferCall` function with the appropriate destination:

Expand All @@ -127,7 +139,7 @@ When the assistant needs to forward a call, it uses the `transferCall` function
}
```

### 3. Customizing Messages
### 4. Customizing Messages

Customize the messages for each destination to provide clear information to the caller:

Expand Down
34 changes: 27 additions & 7 deletions fern/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -116,19 +116,37 @@ navigation:
- page: Inbound support
path: examples/inbound-support.mdx
icon: fa-light fa-phone-volume
- page: Outbound sales
path: examples/outbound-sales.mdx
icon: fa-light fa-money-bill-wave
- page: Pizza website
path: examples/pizza-website.mdx
icon: fa-light fa-pizza-slice
- page: Voice widget
path: examples/voice-widget.mdx
icon: fa-light fa-window-maximize
- page: Documentation agent
path: examples/docs-agent.mdx
icon: fa-light fa-microphone

- section: Workflows
contents:
- page: Quickstart
path: workflows/quickstart.mdx
icon: fa-light fa-bolt-lightning
- page: Overview
path: workflows/overview.mdx
icon: fa-light fa-book
- section: Examples
icon: fa-light fa-code
contents:
- page: Appointment scheduling
path: workflows/examples/appointment-scheduling.mdx
icon: fa-light fa-calendar-check
- page: Outbound sales
path: workflows/examples/outbound-sales.mdx
icon: fa-light fa-money-bill-wave
- page: Medical triage
path: workflows/examples/clinic-triage-scheduling.mdx
icon: fa-light fa-stethoscope
- page: Order management
path: workflows/examples/ecommerce-order-management.mdx
icon: fa-light fa-shopping-cart

- section: Assistant customization
contents:
- section: Conversation behaviour
Expand Down Expand Up @@ -719,7 +737,9 @@ redirects:
- source: "/technical_support"
destination: "/examples/inbound-support"
- source: "/pizza_website"
destination: "/examples/pizza-website"
destination: "/examples/inbound-support"
- source: "/examples/pizza-website"
destination: "/examples/inbound-support"
- source: "/outbound_call_python"
destination: "/examples/outbound-call-python"
- source: "/voice_widget"
Expand Down
2 changes: 1 addition & 1 deletion fern/examples/inbound-support.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ We will be creating a customer support agent for VapiBank, a bank that wants to
</Step>
</Steps>

<video autoPlay loop muted src="../static/videos/inbound-support/upload-files.mp4" type="video/mp4" style={{ aspectRatio: '16 / 9', width: '100%' }} />
<video autoPlay loop muted src="../static/videos/upload-files.mp4" type="video/mp4" style={{ aspectRatio: '16 / 9', width: '100%' }} />

---

Expand Down
158 changes: 0 additions & 158 deletions fern/examples/outbound-sales.mdx

This file was deleted.

Loading
Loading