Skip to content

Commit 30213c6

Browse files
chore: fix gohighlevel name
1 parent cdb11ea commit 30213c6

File tree

2 files changed

+33
-33
lines changed

2 files changed

+33
-33
lines changed

fern/docs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -253,9 +253,9 @@ navigation:
253253
- page: Slack
254254
path: tools/slack.mdx
255255
icon: fa-brands fa-slack
256-
- page: Go High Level
256+
- page: GoHighLevel
257257
path: tools/go-high-level.mdx
258-
icon: fa-light fa-calendar-days
258+
icon: fa-light fa-arrow-up
259259
- section: Knowledge retrieval
260260
path: knowledge-base/knowledge-base.mdx
261261
icon: fa-light fa-book

fern/tools/go-high-level.mdx

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,77 @@
11
---
2-
title: Go High Level Integration
3-
subtitle: "Connect your assistant to Go High Level for seamless appointment scheduling, contact creation, and availability checking."
2+
title: GoHighLevel Integration
3+
subtitle: "Connect your assistant to GoHighLevel for seamless appointment scheduling, contact creation, and availability checking."
44
slug: tools/go-high-level
55
---
66

7-
The Go High Level integration empowers your Vapi voice agents to directly interact with your clients\' GoHighLevel calendars. Your agents can utilize a suite of tools to manage the appointment lifecycle: check if a contact already exists using the **Get Contact** tool, create new leads or clients with the **Create Contact** tool, query specific GHL calendars for open slots via the **Check Availability** tool, and secure appointments associated with a contact using the **Create Event** tool. This enables your voice agent to handle the entire booking process seamlessly within the GHL calendar that your agency or client already uses.
7+
The GoHighLevel integration empowers your Vapi voice agents to directly interact with your clients\' GoHighLevel calendars. Your agents can utilize a suite of tools to manage the appointment lifecycle: check if a contact already exists using the **Get Contact** tool, create new leads or clients with the **Create Contact** tool, query specific GHL calendars for open slots via the **Check Availability** tool, and secure appointments associated with a contact using the **Create Event** tool. This enables your voice agent to handle the entire booking process seamlessly within the GHL calendar that your agency or client already uses.
88

99
## Prerequisites
1010

11-
Before you can use the Go High Level integration, you need to:
11+
Before you can use the GoHighLevel integration, you need to:
1212

1313
1. Have a GoHighLevel account.
1414
2. Have a calendar in GoHighLevel to which you have permission to create and edit events.
1515
3. Have access to the Vapi Dashboard.
1616

1717
## Setup Steps
1818

19-
### 1. Connect Go High Level Account
19+
### 1. Connect GoHighLevel Account
2020

21-
First, you need to connect your Go High Level account to Vapi:
21+
First, you need to connect your GoHighLevel account to Vapi:
2222

2323
1. Navigate to the Vapi Dashboard.
24-
2. Go to **Providers Keys** > **Tools Provider** > **Go High Level**.
24+
2. Go to **Providers Keys** > **Tools Provider** > **GoHighLevel**.
2525
3. Click the **Connect** button.
26-
4. A Go High Level authorization popup will appear.
27-
5. Follow the prompts to authorize Vapi to access your Go High Level account.
26+
4. A GoHighLevel authorization popup will appear.
27+
5. Follow the prompts to authorize Vapi to access your GoHighLevel account.
2828

2929
<Note>
30-
The authorization process will request access to your Go High Level account to
30+
The authorization process will request access to your GoHighLevel account to
3131
manage contacts, calendars, and appointments.
3232
</Note>
3333

34-
<Frame caption="Connect Go High Level Account">
34+
<Frame caption="Connect GoHighLevel Account">
3535
<img
3636
src="../static/images/tools/gohighlevel-connect.png"
37-
alt="Connect Go High Level Account"
37+
alt="Connect GoHighLevel Account"
3838
/>
3939
</Frame>
4040

41-
### 2. Create Go High Level Tools
41+
### 2. Create GoHighLevel Tools
4242

43-
After connecting your Go High Level account, create the tools:
43+
After connecting your GoHighLevel account, create the tools:
4444

4545
1. Go to **Dashboard** > **Tools** page.
4646
2. Click the **Create Tool** button.
47-
3. Select **Go High Level** from the available options.
47+
3. Select **GoHighLevel** from the available options.
4848
4. Choose which tool(s) you want to create (e.g., Get Contact, Create Contact, Check Availability, Create Event).
4949
5. For each tool, provide a name.
5050
6. For the **Check Availability** and **Create Event** tools, ensure you provide a valid `calendarId`. You can find the `calendarId` for each of your calendars in GoHighLevel by navigating to **Settings** > **Calendars**. Each calendar listed will display its unique ID.
5151

5252
<Note>
53-
When creating an event in Go High Level, a `contactId` is required. Therefore,
53+
When creating an event in GoHighLevel, a `contactId` is required. Therefore,
5454
if you plan to use the **Create Event** tool, you **must** also add the **Get
5555
Contact** and **Create Contact** tools. This allows the assistant to first
5656
retrieve an existing contact\'s ID or create a new contact, and then use that
5757
ID to schedule the event.
5858
</Note>
5959

60-
<Frame caption="Create Go High Level Tools">
60+
<Frame caption="Create GoHighLevel Tools">
6161
<img
6262
src="../static/images/tools/gohighlevel-create.png"
63-
alt="Create Go High Level Tools"
63+
alt="Create GoHighLevel Tools"
6464
/>
6565
</Frame>
6666

6767
### 3. Add Tools to Assistant
6868

69-
Now, add your chosen Go High Level tool(s) to your assistant. For an example scenario where you want your assistant to book appointments, including finding a suitable time and managing contact information, you would add all four tools: Get Contact, Create Contact, Check Availability, and Create Event.
69+
Now, add your chosen GoHighLevel tool(s) to your assistant. For an example scenario where you want your assistant to book appointments, including finding a suitable time and managing contact information, you would add all four tools: Get Contact, Create Contact, Check Availability, and Create Event.
7070

7171
1. Navigate to **Dashboard** > **Assistants** page.
7272
2. Select your assistant.
7373
3. Go to the **Tools** tab.
74-
4. In the tools dropdown, select the Go High Level tool(s) you want to use.
74+
4. In the tools dropdown, select the GoHighLevel tool(s) you want to use.
7575
5. Click **Publish** to save your changes.
7676

7777
<Frame caption="Add GHL Tools to Assistant">
@@ -83,7 +83,7 @@ Now, add your chosen Go High Level tool(s) to your assistant. For an example sce
8383

8484
### 4. Configure Assistant System Prompt
8585

86-
After adding the Go High Level tools to your assistant, it\'s crucial to provide a clear system prompt. This prompt guides the assistant on how and when to use each tool to achieve the desired workflow. For a typical appointment booking scenario, your system prompt instructs the AI on the sequence of operations and conditions for using each tool.
86+
After adding the GoHighLevel tools to your assistant, it\'s crucial to provide a clear system prompt. This prompt guides the assistant on how and when to use each tool to achieve the desired workflow. For a typical appointment booking scenario, your system prompt instructs the AI on the sequence of operations and conditions for using each tool.
8787

8888
Here\'s an example system prompt to guide your assistant. Remember to replace `ghl_contact_get`, `ghl_contact_create`, `ghl_check_availability`, and `ghl_create_event` with the exact names you gave your tools if they are different.
8989

@@ -106,14 +106,14 @@ You are a helpful and efficient scheduling assistant. Your primary goal is to bo
106106

107107
## Tool Configurations
108108

109-
### Go High Level Get Contact Tool
109+
### GoHighLevel Get Contact Tool
110110

111111
This tool uses both or one of the following fields to retrieve an existing contact:
112112

113113
- `email`: The email address of the contact to search for.
114114
- `phone`: The phone number of the contact to search for.
115115

116-
### Go High Level Create Contact Tool
116+
### GoHighLevel Create Contact Tool
117117

118118
This tool uses the following fields to create a new contact:
119119

@@ -122,31 +122,31 @@ This tool uses the following fields to create a new contact:
122122
- `email`: The email address of the contact.
123123
- `phone`: The phone number of the contact.
124124

125-
### Go High Level Check Availability Tool
125+
### GoHighLevel Check Availability Tool
126126

127127
This tool uses the following fields to check for open appointment slots:
128128

129-
- `calendarId`: The ID of the Go High Level calendar to check.
129+
- `calendarId`: The ID of the GoHighLevel calendar to check.
130130
- `startDateTime`: The start of the time range to check for availability (epoch time in milliseconds).
131131
- `endDateTime`: The end of the time range to check for availability (epoch time in milliseconds).
132132
- `timezone`: The timezone for the availability check (e.g., "America/New_York").
133133

134134
<Info>
135-
For the Go High Level Check Availability Tool, `startDateTime` and `endDateTime` must be provided in epoch time (milliseconds).
135+
For the GoHighLevel Check Availability Tool, `startDateTime` and `endDateTime` must be provided in epoch time (milliseconds).
136136
</Info>
137137

138-
### Go High Level Create Event Tool
138+
### GoHighLevel Create Event Tool
139139

140140
This tool uses the following fields to book an appointment:
141141

142-
- `calendarId`: The ID of the Go High Level calendar in which to create the event.
143-
- `contactId`: The ID of the Go High Level contact to associate with the event.
142+
- `calendarId`: The ID of the GoHighLevel calendar in which to create the event.
143+
- `contactId`: The ID of the GoHighLevel contact to associate with the event.
144144
- `title`: The title or summary for the calendar event.
145145
- `startDateTime`: The start date and time for the event.
146146
- `endDateTime`: The end date and time for the event.
147147

148148
<Info>
149-
For the Go High Level Create Event Tool, `startDateTime` and `endDateTime` fields should be provided in ISO 8601 format (e.g., `2024-07-31T14:30:00-04:00` or `2024-08-01T10:00:00Z`).
149+
For the GoHighLevel Create Event Tool, `startDateTime` and `endDateTime` fields should be provided in ISO 8601 format (e.g., `2024-07-31T14:30:00-04:00` or `2024-08-01T10:00:00Z`).
150150
</Info>
151151

152152
## Example Usage
@@ -219,7 +219,7 @@ Here's how the tools can be configured in your assistant's JSON setup:
219219
icon="question-circle"
220220
href="https://discord.gg/pUFNcf2WmH"
221221
>
222-
Join our Discord community for support with Go High Level integration
222+
Join our Discord community for support with GoHighLevel integration
223223
</Card>
224224
<Card
225225
title="API Reference"

0 commit comments

Comments
 (0)