CONNECT APP
Build with HighLevel
CRM
- OAuth
MCP
Give your agent HighLevel tools
Every HighLevel action is exposed as an MCP tool on Pipedream's remote server. Point a client at it with your end user's ID and Connect resolves that user's HighLevel account for each tool call — you store no tokens.
// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "highlevel_oauth",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run Add Contact to Campaign:
const result = await mcp.callTool({
name: "highlevel_oauth-add-contact-to-campaign",
arguments: {
contactId: "Contact ID",
campaignId: "Campaign ID",
},
})# access_token: mint a short-lived token with the Connect SDK — see the MCP guide
headers = {
"Authorization": f"Bearer {access_token}",
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", # any stable ID for this user in your system
"x-pd-app-slug": "highlevel_oauth",
}
async with streamablehttp_client("https://remote.mcp.pipedream.net/v3", headers=headers) as (read, write, _):
async with ClientSession(read, write) as session:
await session.initialize()
tools = await session.list_tools()
# e.g. run Add Contact to Campaign:
result = await session.call_tool("highlevel_oauth-add-contact-to-campaign", {
"contactId": "Contact ID",
"campaignId": "Campaign ID",
})API PROXY
Call the HighLevel API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the HighLevel API with the connected user's credentials attached. You store no tokens and write no refresh logic.
const resp = await pd.proxy.get({
externalUserId: "{external_user_id}", // any stable ID for this user in your system
accountId: "apn_xxxxxxx",
url: "https://api.example.com/v1/me",
})
// Any allowed HighLevel endpoint works here. Pipedream attaches the
// connected account's credentials to the outgoing request.# The path segment is the target URL, URL-safe base64 encoded:
# https://api.example.com/v1/me
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcGkuZXhhbXBsZS5jb20vdjEvbWU?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"SDK
Run HighLevel actions from your backend
Connect a user's HighLevel account once, then run Add Contact to Campaign on their behalf from your own code — TypeScript, Python, or plain HTTP.
import { PipedreamClient } from "@pipedream/sdk"
const pd = new PipedreamClient({
projectId: process.env.PIPEDREAM_PROJECT_ID!,
clientId: process.env.PIPEDREAM_CLIENT_ID!,
clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
projectEnvironment: "production",
})
const result = await pd.actions.run({
id: "highlevel_oauth-add-contact-to-campaign",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
highlevel_oauth: { authProvisionId: "apn_xxxxxxx" },
contactId: "Contact ID",
campaignId: "Campaign ID",
},
})from pipedream import Pipedream
pd = Pipedream(
client_id="{oauth_client_id}",
client_secret="{oauth_client_secret}",
project_id="{project_id}",
project_environment="production",
)
result = pd.actions.run(
id="highlevel_oauth-add-contact-to-campaign",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"highlevel_oauth": {"authProvisionId": "apn_xxxxxxx"},
"contactId": "Contact ID",
"campaignId": "Campaign ID",
},
)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "highlevel_oauth-add-contact-to-campaign",
"configured_props": {
"highlevel_oauth": { "authProvisionId": "apn_xxxxxxx" },
"contactId": "Contact ID",
"campaignId": "Campaign ID"
}
}'TOOLS
HighLevel actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Add Contact to Campaign
actionAdds an existing contact to a campaign. See the documentationWritev0.0.3 -
Create Contact
actionCreates a new contact on HighLevel. See the documentationWritev0.0.4 -
List Businesses
actionRetrieves all businesses for a location in HighLevel. See the documentationRead-onlyv0.0.1 -
List Campaign ID Options
actionRetrieves available options for the Campaign ID field.Read-onlyv0.0.1 -
Update Contact
actionUpdates a selected contact on HighLevel. See the documentationWritev0.0.4 -
Upsert Contact
actionCreates or updates a contact on HighLevel. See the documentationWritev0.0.4
EVENTS
HighLevel triggers
Event sources your backend can deploy for users and receive through a webhook.
MULTI-APP
Use HighLevel with other popular apps
Most products don't stop at one integration. Pair HighLevel with the other apps your users rely on, and ship use cases that span both.
- App slug
- highlevel_oauth
- Authentication
- OAuth
- Categories
- CRM
- Actions
- 6
- Triggers
- 2
- API proxy
- Available
OAuth scopes
These are the scopes Pipedream's managed HighLevel OAuth client requests when one of your users connects an account. Supply your own OAuth client to request a different set.
- businesses.readonly
- businesses.write
- calendars.write
- calendars.readonly
- calendars/events.readonly
- calendars/events.write
- campaigns.readonly
- contacts.readonly
- contacts.write
- conversations.readonly
- conversations.write
- conversations/message.readonly
- conversations/message.write
- forms.readonly
- links.readonly
- links.write
- locations.readonly
- locations.write
- locations/customValues.readonly
- locations/customValues.write
- locations/customFields.readonly
- locations/customFields.write
- locations/tags.readonly
- locations/tags.write
- locations/templates.readonly
- locations/tasks.readonly
- opportunities.readonly
- opportunities.write
- snapshots.readonly
- surveys.readonly
- users.readonly
- users.write
- workflows.readonly