You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: fern/tools/go-high-level.mdx
+31-31Lines changed: 31 additions & 31 deletions
Original file line number
Diff line number
Diff line change
@@ -1,77 +1,77 @@
1
1
---
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."
4
4
slug: tools/go-high-level
5
5
---
6
6
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.
8
8
9
9
## Prerequisites
10
10
11
-
Before you can use the Go High Level integration, you need to:
11
+
Before you can use the GoHighLevel integration, you need to:
12
12
13
13
1. Have a GoHighLevel account.
14
14
2. Have a calendar in GoHighLevel to which you have permission to create and edit events.
15
15
3. Have access to the Vapi Dashboard.
16
16
17
17
## Setup Steps
18
18
19
-
### 1. Connect Go High Level Account
19
+
### 1. Connect GoHighLevel Account
20
20
21
-
First, you need to connect your Go High Level account to Vapi:
21
+
First, you need to connect your GoHighLevel account to Vapi:
22
22
23
23
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**.
25
25
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.
28
28
29
29
<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
After connecting your Go High Level account, create the tools:
43
+
After connecting your GoHighLevel account, create the tools:
44
44
45
45
1. Go to **Dashboard** > **Tools** page.
46
46
2. Click the **Create Tool** button.
47
-
3. Select **Go High Level** from the available options.
47
+
3. Select **GoHighLevel** from the available options.
48
48
4. Choose which tool(s) you want to create (e.g., Get Contact, Create Contact, Check Availability, Create Event).
49
49
5. For each tool, provide a name.
50
50
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.
51
51
52
52
<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,
54
54
if you plan to use the **Create Event** tool, you **must** also add the **Get
55
55
Contact** and **Create Contact** tools. This allows the assistant to first
56
56
retrieve an existing contact\'s ID or create a new contact, and then use that
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.
70
70
71
71
1. Navigate to **Dashboard** > **Assistants** page.
72
72
2. Select your assistant.
73
73
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.
75
75
5. Click **Publish** to save your changes.
76
76
77
77
<Framecaption="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
83
83
84
84
### 4. Configure Assistant System Prompt
85
85
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.
87
87
88
88
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.
89
89
@@ -106,14 +106,14 @@ You are a helpful and efficient scheduling assistant. Your primary goal is to bo
106
106
107
107
## Tool Configurations
108
108
109
-
### Go High Level Get Contact Tool
109
+
### GoHighLevel Get Contact Tool
110
110
111
111
This tool uses both or one of the following fields to retrieve an existing contact:
112
112
113
113
-`email`: The email address of the contact to search for.
114
114
-`phone`: The phone number of the contact to search for.
115
115
116
-
### Go High Level Create Contact Tool
116
+
### GoHighLevel Create Contact Tool
117
117
118
118
This tool uses the following fields to create a new contact:
119
119
@@ -122,31 +122,31 @@ This tool uses the following fields to create a new contact:
122
122
-`email`: The email address of the contact.
123
123
-`phone`: The phone number of the contact.
124
124
125
-
### Go High Level Check Availability Tool
125
+
### GoHighLevel Check Availability Tool
126
126
127
127
This tool uses the following fields to check for open appointment slots:
128
128
129
-
-`calendarId`: The ID of the Go High Level calendar to check.
129
+
-`calendarId`: The ID of the GoHighLevel calendar to check.
130
130
-`startDateTime`: The start of the time range to check for availability (epoch time in milliseconds).
131
131
-`endDateTime`: The end of the time range to check for availability (epoch time in milliseconds).
132
132
-`timezone`: The timezone for the availability check (e.g., "America/New_York").
133
133
134
134
<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).
136
136
</Info>
137
137
138
-
### Go High Level Create Event Tool
138
+
### GoHighLevel Create Event Tool
139
139
140
140
This tool uses the following fields to book an appointment:
141
141
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.
144
144
-`title`: The title or summary for the calendar event.
145
145
-`startDateTime`: The start date and time for the event.
146
146
-`endDateTime`: The end date and time for the event.
147
147
148
148
<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`).
150
150
</Info>
151
151
152
152
## Example Usage
@@ -219,7 +219,7 @@ Here's how the tools can be configured in your assistant's JSON setup:
219
219
icon="question-circle"
220
220
href="https://discord.gg/pUFNcf2WmH"
221
221
>
222
-
Join our Discord community for support with Go High Level integration
222
+
Join our Discord community for support with GoHighLevel integration
0 commit comments