Skip to content

Commit 3dd18d7

Browse files
Update dashboard directions (#1359)
* Updated images and dashboard directions * docs: clarify dashboard setup steps * Updated directions
1 parent 9fe7fc0 commit 3dd18d7

11 files changed

Lines changed: 52 additions & 28 deletions

‎fern/assistants/call-recording.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ The consent assistant runs without generating artifacts, while the main assistan
136136
</Step>
137137

138138
<Step title="Publish the assistant">
139-
Select **publish** in the unsaved-changes message to apply the update.
139+
Select **Publish** in the assistant header. Review the changes, then select **Next**. Enter a **Version Name** and, optionally, a **Description**. Select **Publish** to make the assistant version current.
140140
</Step>
141141
</Steps>
142142

‎fern/assistants/end-call-phrases.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Avoid unnecessary punctuation and whitespace inside a phrase. A short phrase suc
3333
</Step>
3434

3535
<Step title="Find the end call settings">
36-
In the assistant editor, open the **Advanced** tab and find **End Call Message** and **End Call Phrases**.
36+
Open the **Advanced** tab and expand **Messaging**. Find **End Call Message** and **End Call Phrases**.
3737

3838
<Frame caption="End Call Message and End Call Phrases in the Advanced tab">
3939
<img src="/static/images/tools/hang-up/06-end-call-phrases.png" alt="Vapi Dashboard Advanced tab with End Call Message set to Goodbye and End Call Phrases set to Thanks for calling. Goodbye." />

‎fern/calls/assistant-based-warm-transfer.mdx‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,16 @@ Create a reusable transfer call tool, configure a phone-number destination, and
5757
Enter the **Message to Operator**. Under **Fallback Plan**, set the message spoken to the customer when the transfer fails and choose whether to end the call. Under **Summary Plan**, choose whether to generate a conversation summary for the operator.
5858
</Step>
5959

60-
<Step title="Save and add the tool to the assistant">
61-
Click **Save**. Open **Assistants**, select the original assistant, and add the tool from the assistant's **Tools** section. Update the system prompt with the conditions for starting the transfer, then save the assistant.
60+
<Step title="Publish the tool">
61+
Select **Publish** in the tool header. Review the changes, then select **Next**. Enter a **Version Name** and, optionally, a **Description**. Select **Publish** to make the tool version current.
62+
</Step>
63+
64+
<Step title="Add the tool to the assistant">
65+
Open **Assistants** and select the original assistant. In the assistant's **Tools** section, select **Add tool** and choose the transfer call tool. Update the system prompt with the conditions for starting the transfer.
66+
</Step>
67+
68+
<Step title="Publish the assistant">
69+
Select **Publish** in the assistant header. Review the changes, then select **Next**. Enter a **Version Name** and, optionally, a **Description**. Select **Publish** to make the assistant version current.
6270
</Step>
6371
</Steps>
6472

‎fern/calls/voicemail-detection.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ All three providers — **Vapi, Google, and OpenAI** — support **interruption
6868
</Step>
6969

7070
<Step title="Publish the assistant">
71-
Select **publish** in the unsaved-changes message to apply the update.
71+
Select **Publish** in the assistant header. Review the changes, then select **Next**. Enter a **Version Name** and, optionally, a **Description**. Select **Publish** to make the assistant version current.
7272
</Step>
7373
</Steps>
7474

‎fern/chat/quickstart.mdx‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -49,17 +49,14 @@ We'll create a customer support chat for "TechFlow", a software company that wan
4949
## 2. Create or Select an Assistant
5050

5151
<Steps>
52-
<Step title="Navigate to Assistants">
53-
In your Vapi dashboard, click `Assistants` in the left sidebar.
52+
<Step title="Open Assistants">
53+
In the [Vapi Dashboard](https://dashboard.vapi.ai), select **Assistants**.
5454
</Step>
55-
<Step title="Create a new assistant (or use existing)">
56-
- Click `Create Assistant` if you need a new one
57-
- Select `Blank Template` as your starting point
58-
- Name it `TechFlow Support`
59-
- Set the first message to: `Hello! I'm here to help with TechFlow questions. What can I assist you with today?`
55+
<Step title="Create or select an assistant">
56+
Select **Create Assistant** to create a blank assistant, or open an existing assistant. For a new assistant, select **Edit** beside its name, enter `TechFlow Support`, then select **Save**. On the **Assistant** tab, enter `Hello! I'm here to help with TechFlow questions. What can I assist you with today?` in **First message**.
6057
</Step>
6158
<Step title="Configure the system prompt">
62-
Update the system prompt to:
59+
On the **Assistant** tab, enter the following in **System prompt**:
6360

6461
```txt title="System Prompt" maxLines=8
6562
You are a helpful customer support agent for TechFlow, a software company.
@@ -72,8 +69,11 @@ We'll create a customer support chat for "TechFlow", a software company that wan
7269
Keep responses concise and helpful. Always maintain a friendly, professional tone.
7370
```
7471
</Step>
72+
<Step title="Publish the assistant">
73+
Select **Publish**, review the changes, then select **Next**. Enter a version name, review the traffic settings, then select **Publish**.
74+
</Step>
7575
<Step title="Copy the Assistant ID">
76-
After publishing, copy the Assistant ID from the URL or assistant details. You'll need this for API calls.
76+
Select the copy button beside the Assistant ID in the assistant header. You'll need this ID for API calls.
7777
</Step>
7878
</Steps>
7979

@@ -357,7 +357,7 @@ The chat API supports the following webhook events through server messaging:
357357
- **`chat.created`** - Triggered when a new chat conversation is initiated
358358
- **`chat.deleted`** - Triggered when a chat conversation is deleted
359359

360-
To receive these webhooks, go to your Assistant page in the Dashboard and navigate to "Server Messaging" and select the events you want to receive.
360+
To receive these webhooks, open the assistant in the [Vapi Dashboard](https://dashboard.vapi.ai). On **Advanced**, enter your endpoint in **Webhook Server** → **Server URL**. Under **Messaging** → **Server Messages**, select `chat.created` and `chat.deleted`. Select **Publish**, review the changes, then select **Next**. Enter a version name, review the traffic settings, then select **Publish**.
361361

362362
These webhooks are useful for tracking conversation analytics, maintaining conversation history in your own database, and triggering follow-up actions.
363363
</Note>

‎fern/chat/session-management.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,7 @@ Sessions support the following webhook events through server messaging:
259259
- **`session.updated`** - Triggered when a session is updated
260260
- **`session.deleted`** - Triggered when a session is deleted
261261

262-
To receive these webhooks, go to your Assistant page in the Dashboard and navigate to "Server Messaging" and select the events you want to receive.
262+
To receive these webhooks, open the assistant in the [Vapi Dashboard](https://dashboard.vapi.ai). On **Advanced**, enter your endpoint in **Webhook Server** → **Server URL**. Under **Messaging** → **Server Messages**, select `session.created`, `session.updated`, and `session.deleted`. Select **Publish**, review the changes, then select **Next**. Enter a version name, review the traffic settings, then select **Publish**.
263263

264264
These webhooks are useful for tracking session lifecycle, managing session state in your own database, and triggering workflows based on session changes.
265265
</Note>

‎fern/outbound-campaigns/build-personalized-appointment-campaign.mdx‎

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -87,15 +87,23 @@ For more formatting rules and limits, see [Campaign contact data](/outbound-camp
8787
<Tab title="Dashboard">
8888
<Steps>
8989
<Step title="Create the voicemail tool">
90-
In the [Vapi Dashboard](https://dashboard.vapi.ai), go to **Tools** and select **Create Tool**. Choose **Voicemail**, name it `leave_voicemail_for_appointment`, and add a description. Select **Use custom script** and paste the **voicemail script** above, then save the tool.
90+
In the [Vapi Dashboard](https://dashboard.vapi.ai), select **Tools**, then **Create Tool**. Select **Leave Voicemail** under **Phone Call Tools**. Name it `leave_voicemail_for_appointment` and add a description. Under **Voicemail Script**, select **Use custom script** and paste the voicemail script above.
91+
</Step>
92+
93+
<Step title="Publish the voicemail tool">
94+
Select **Publish** to save the tool configuration.
9195
</Step>
9296

9397
<Step title="Create the assistant">
94-
Go to **Assistants** and create an assistant. Set **First Message Mode** to **Assistant waits for user**, leave the first-message text empty, and paste the **system prompt** above.
98+
Select **Assistants**, then **Create Assistant**. On the **Assistant** tab, select **Assistant waits for user** under **First message**, leave the first-message text empty, and paste the system prompt above into **System prompt**.
99+
</Step>
100+
101+
<Step title="Add the voicemail tool">
102+
On the assistant's **Tools** tab, select **Add tool** and choose `leave_voicemail_for_appointment`. On **Advanced**, under **Voicemail Detection**, set **Voicemail Detection Provider** to **Off** so automatic detection does not compete with the tool.
95103
</Step>
96104

97-
<Step title="Add the tool and publish">
98-
Open the assistant's **Tools** section and add the `leave_voicemail_for_appointment` tool. Keep automatic voicemail detection disabled so the two approaches do not compete, then publish the assistant.
105+
<Step title="Publish the assistant">
106+
Select **Publish**, review the changes, then select **Next**. Enter a version name, review the traffic settings, then select **Publish**.
99107
</Step>
100108

101109
<Step title="Configure the campaign caller">

‎fern/outbound-campaigns/quickstart.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,11 @@ answer.
4242
</Step>
4343

4444
<Step title="Add the system prompt">
45-
In the assistant's **Model** section, paste the **system prompt** above into the system prompt field.
45+
On the **Assistant** tab, paste the prompt above into **System prompt**.
4646
</Step>
4747

4848
<Step title="Publish the assistant">
49-
Publish the assistant so the campaign can use it.
49+
Select **Publish**, review the changes, then select **Next**. Enter a version name, review the traffic settings, then select **Publish**. The campaign can use the published assistant.
5050
</Step>
5151
</Steps>
5252
</Tab>

‎fern/phone-numbers/didww.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,15 @@ slug: phone-numbers/didww
3737
</Step>
3838

3939
<Step title="Enter the DIDWW number">
40-
Enter the number in E.164 format, including the `+` prefix. Leave **Allow non-E164 phone numbers** off, select the **DIDWW Inbound Trunk** credential, and optionally add a label. Then click **Import SIP Phone Number**.
40+
Enter the number in E.164 format, including the `+` prefix. Leave **Allow non-E164 phone numbers** off, select the **DIDWW Inbound Trunk** credential created in the [DIDWW SIP integration](/advanced/sip/didww), and optionally add a label. Then select **Import SIP Phone Number**.
4141

4242
<Frame caption="Import the DIDWW number with the DIDWW SIP trunk credential.">
43-
<img src="../static/images/quickstart/phone/import-didww-number-dashboard.png" alt="Vapi Create Phone Number form with BYO SIP Trunk Number selected and the DIDWW Inbound Trunk credential chosen" />
43+
<img src="../static/images/quickstart/phone/import-didww-number-dashboard.png" alt="Vapi Create Phone Number form with BYO SIP Trunk Number selected and an inbound SIP trunk credential chosen" />
4444
</Frame>
4545
</Step>
4646

4747
<Step title="Assign an assistant">
48-
Open the imported number, select an assistant under **Inbound Settings**, and click **Save**.
48+
Open the imported number, select an assistant under **Inbound Settings**, and select **Save**.
4949

5050
<Frame caption="Assign an assistant to handle inbound calls to the DIDWW number.">
5151
<img src="../static/images/quickstart/phone/didww-number-assign-assistant.png" alt="Vapi phone number Inbound Settings with an assistant selected to handle inbound calls" />

‎fern/phone-numbers/telnyx.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ This guide shows you how to import your existing Telnyx phone numbers to the Vap
2828
Select **Create Phone Number**, then choose **Import Telnyx** under **Phone Number Options**.
2929
</Step>
3030

31-
<Step title="Enter the Telnyx number and API key">
32-
Enter the number, including its country code, in **Telnyx Phone Number**. Enter your key in **API Key** and, optionally, enter a descriptive **Label**. Then select **Import from Telnyx**.
31+
<Step title="Enter the Telnyx number">
32+
Enter the number, including its country code, in **Telnyx Phone Number**. If your organization has no Telnyx credential, enter your Telnyx key in **API Key**. When a Telnyx credential already exists, Vapi uses it for the import and omits **API Key**. Optionally, enter a descriptive **Label**. Then select **Import from Telnyx**.
3333

3434
<Frame caption="Import a Telnyx phone number">
3535
<img src="../static/images/quickstart/dashboard/import-telnyx-number-dashboard-current.png" />

0 commit comments

Comments
 (0)