> ## Documentation Index
> Fetch the complete documentation index at: https://docs.automate.ax/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Automate.ax automations are TypeScript programs.
> Use Bun for installation and command examples.
> Use Automate.ax for the product name and automate.ax for the package, CLI, and domain.
> Treat documented public APIs as current; do not invent transitional or deprecated names.

# HighLevel

> Automate HighLevel contacts, opportunities, calendars, conversations, messages, and signed sub-account events.

```ts automations/highlevel-new-contact-follow-up.automation.ts theme={null}
import { automation, markSignificant } from "automate.ax"
import { highlevel } from "automate.ax/highlevel"

export default automation("Follow up on new HighLevel contacts", () => {
  const contact = highlevel.onContactCreated()

  markSignificant(
    highlevel.createContactTask({
      contactId: contact.id,
      title: "Qualify the new contact",
      dueDate: "2026-09-10T17:00:00.000Z",
      completed: false,
    }),
  )
})
```

Connect HighLevel with OAuth or a Private Integration Token. OAuth is required for triggers. Actions support either method when the credential grants the action's required scope. Each connection represents one HighLevel location, also called a sub-account; Automate.ax supplies its `locationId` to every request.

Actions cover contacts, tags, contact tasks and notes, campaign and workflow membership, opportunities and pipelines, calendars, appointments and schedules, conversations, messages, users, forms and surveys. List and search actions expose HighLevel's provider-native pagination fields.

HighLevel enforces burst and daily rate limits per resource. Automate.ax treats validation and permission responses as terminal failures, retries server failures according to action safety, and honors `Retry-After` or HighLevel's interval header on rate limits.

## Connect with OAuth

Choose OAuth for actions and triggers. Automate.ax requests only the scopes required by your automations plus location identity access. HighLevel access tokens expire daily; Automate.ax rotates the refresh token automatically.

To receive triggers, publish or privately install the Automate.ax marketplace app for the location and configure its webhook URL as `https://automate.ax/api/v1/events/highlevel`. Enable the event types your automations use. The broad trigger requires all supported webhook event scopes.

## Connect with a Private Integration Token

In HighLevel, create a Private Integration Token for the location, grant `locations.readonly` plus the scopes required by your actions, then paste the token and location ID into Automate.ax. Automate.ax uses location access to validate the credential and label the connection. Private tokens support actions only because HighLevel marketplace webhooks are tied to OAuth app installations.

## Exports

```ts theme={null}
import {
  highlevel,
  highLevelAccount,
  getHighLevelApi,
} from "automate.ax/highlevel"
```

* `highlevel` contains the packaged HighLevel actions and triggers.
* `highLevelAccount("name")` selects a named HighLevel connection.
* `getHighLevelApi` creates the authenticated HighLevel API helper for a custom account-backed action.

## Triggers

* [On HighLevel event](/reference/integrations/highlevel/triggers/on-event)
* [On HighLevel appointment created](/reference/integrations/highlevel/triggers/on-appointment-created)
* [On HighLevel appointment updated](/reference/integrations/highlevel/triggers/on-appointment-updated)
* [On HighLevel appointment deleted](/reference/integrations/highlevel/triggers/on-appointment-deleted)
* [On HighLevel campaign status updated](/reference/integrations/highlevel/triggers/on-campaign-status-updated)
* [On HighLevel contact created](/reference/integrations/highlevel/triggers/on-contact-created)
* [On HighLevel contact updated](/reference/integrations/highlevel/triggers/on-contact-updated)
* [On HighLevel contact deleted](/reference/integrations/highlevel/triggers/on-contact-deleted)
* [On HighLevel contact DND updated](/reference/integrations/highlevel/triggers/on-contact-dnd-updated)
* [On HighLevel contact tags updated](/reference/integrations/highlevel/triggers/on-contact-tags-updated)
* [On HighLevel conversation unread state updated](/reference/integrations/highlevel/triggers/on-conversation-unread-updated)
* [On HighLevel conversation updated](/reference/integrations/highlevel/triggers/on-conversation-updated)
* [On HighLevel message received](/reference/integrations/highlevel/triggers/on-message-received)
* [On HighLevel message sent](/reference/integrations/highlevel/triggers/on-message-sent)
* [On HighLevel note created](/reference/integrations/highlevel/triggers/on-note-created)
* [On HighLevel note updated](/reference/integrations/highlevel/triggers/on-note-updated)
* [On HighLevel note deleted](/reference/integrations/highlevel/triggers/on-note-deleted)
* [On HighLevel opportunity created](/reference/integrations/highlevel/triggers/on-opportunity-created)
* [On HighLevel opportunity updated](/reference/integrations/highlevel/triggers/on-opportunity-updated)
* [On HighLevel opportunity deleted](/reference/integrations/highlevel/triggers/on-opportunity-deleted)
* [On HighLevel opportunity stage updated](/reference/integrations/highlevel/triggers/on-opportunity-stage-updated)
* [On HighLevel opportunity status updated](/reference/integrations/highlevel/triggers/on-opportunity-status-updated)
* [On HighLevel opportunity value updated](/reference/integrations/highlevel/triggers/on-opportunity-value-updated)
* [On HighLevel opportunity assignee updated](/reference/integrations/highlevel/triggers/on-opportunity-assignee-updated)
* [On HighLevel task created](/reference/integrations/highlevel/triggers/on-task-created)
* [On HighLevel task completed](/reference/integrations/highlevel/triggers/on-task-completed)
* [On HighLevel task deleted](/reference/integrations/highlevel/triggers/on-task-deleted)
* [On HighLevel location updated](/reference/integrations/highlevel/triggers/on-location-updated)
* [On HighLevel user created](/reference/integrations/highlevel/triggers/on-user-created)
* [On HighLevel user updated](/reference/integrations/highlevel/triggers/on-user-updated)
* [On HighLevel user deleted](/reference/integrations/highlevel/triggers/on-user-deleted)

## Actions

* [List contacts](/reference/integrations/highlevel/actions/list-contacts)
* [Get contact](/reference/integrations/highlevel/actions/get-contact)
* [Search contacts](/reference/integrations/highlevel/actions/search-contacts)
* [Find duplicate contact](/reference/integrations/highlevel/actions/find-duplicate-contact)
* [Create contact](/reference/integrations/highlevel/actions/create-contact)
* [Upsert contact](/reference/integrations/highlevel/actions/upsert-contact)
* [Update contact](/reference/integrations/highlevel/actions/update-contact)
* [Delete contact](/reference/integrations/highlevel/actions/delete-contact)
* [Add contact tags](/reference/integrations/highlevel/actions/add-contact-tags)
* [Remove contact tags](/reference/integrations/highlevel/actions/remove-contact-tags)
* [List contact tasks](/reference/integrations/highlevel/actions/list-contact-tasks)
* [Get contact task](/reference/integrations/highlevel/actions/get-contact-task)
* [Create contact task](/reference/integrations/highlevel/actions/create-contact-task)
* [Update contact task](/reference/integrations/highlevel/actions/update-contact-task)
* [Complete contact task](/reference/integrations/highlevel/actions/complete-contact-task)
* [Delete contact task](/reference/integrations/highlevel/actions/delete-contact-task)
* [List contact notes](/reference/integrations/highlevel/actions/list-contact-notes)
* [Get contact note](/reference/integrations/highlevel/actions/get-contact-note)
* [Create contact note](/reference/integrations/highlevel/actions/create-contact-note)
* [Update contact note](/reference/integrations/highlevel/actions/update-contact-note)
* [Delete contact note](/reference/integrations/highlevel/actions/delete-contact-note)
* [Add contact to campaign](/reference/integrations/highlevel/actions/add-contact-to-campaign)
* [Remove contact from campaign](/reference/integrations/highlevel/actions/remove-contact-from-campaign)
* [Add contact to workflow](/reference/integrations/highlevel/actions/add-contact-to-workflow)
* [Remove contact from workflow](/reference/integrations/highlevel/actions/remove-contact-from-workflow)
* [Search opportunities](/reference/integrations/highlevel/actions/search-opportunities)
* [Get opportunity](/reference/integrations/highlevel/actions/get-opportunity)
* [Create opportunity](/reference/integrations/highlevel/actions/create-opportunity)
* [Upsert opportunity](/reference/integrations/highlevel/actions/upsert-opportunity)
* [Update opportunity](/reference/integrations/highlevel/actions/update-opportunity)
* [Update opportunity status](/reference/integrations/highlevel/actions/update-opportunity-status)
* [Delete opportunity](/reference/integrations/highlevel/actions/delete-opportunity)
* [List pipelines](/reference/integrations/highlevel/actions/list-pipelines)
* [List opportunity lost reasons](/reference/integrations/highlevel/actions/list-opportunity-lost-reasons)
* [List calendars](/reference/integrations/highlevel/actions/list-calendars)
* [Get calendar](/reference/integrations/highlevel/actions/get-calendar)
* [Create calendar](/reference/integrations/highlevel/actions/create-calendar)
* [Update calendar](/reference/integrations/highlevel/actions/update-calendar)
* [Delete calendar](/reference/integrations/highlevel/actions/delete-calendar)
* [Get calendar free slots](/reference/integrations/highlevel/actions/get-calendar-free-slots)
* [List appointments](/reference/integrations/highlevel/actions/list-appointments)
* [Get appointment](/reference/integrations/highlevel/actions/get-appointment)
* [Create appointment](/reference/integrations/highlevel/actions/create-appointment)
* [Update appointment](/reference/integrations/highlevel/actions/update-appointment)
* [Delete appointment](/reference/integrations/highlevel/actions/delete-appointment)
* [List blocked slots](/reference/integrations/highlevel/actions/list-blocked-slots)
* [Create blocked slot](/reference/integrations/highlevel/actions/create-blocked-slot)
* [Update blocked slot](/reference/integrations/highlevel/actions/update-blocked-slot)
* [List schedules](/reference/integrations/highlevel/actions/list-schedules)
* [Get schedule](/reference/integrations/highlevel/actions/get-schedule)
* [Create schedule](/reference/integrations/highlevel/actions/create-schedule)
* [Update schedule](/reference/integrations/highlevel/actions/update-schedule)
* [Delete schedule](/reference/integrations/highlevel/actions/delete-schedule)
* [Search conversations](/reference/integrations/highlevel/actions/search-conversations)
* [Get conversation](/reference/integrations/highlevel/actions/get-conversation)
* [Create conversation](/reference/integrations/highlevel/actions/create-conversation)
* [Update conversation](/reference/integrations/highlevel/actions/update-conversation)
* [Delete conversation](/reference/integrations/highlevel/actions/delete-conversation)
* [List messages](/reference/integrations/highlevel/actions/list-messages)
* [Get message](/reference/integrations/highlevel/actions/get-message)
* [Send message](/reference/integrations/highlevel/actions/send-message)
* [Cancel scheduled message](/reference/integrations/highlevel/actions/cancel-scheduled-message)
* [Cancel scheduled email message](/reference/integrations/highlevel/actions/cancel-scheduled-email-message)
* [Get message recording](/reference/integrations/highlevel/actions/get-message-recording)
* [Get message transcription](/reference/integrations/highlevel/actions/get-message-transcription)
* [Get location](/reference/integrations/highlevel/actions/get-location)
* [List users](/reference/integrations/highlevel/actions/list-users)
* [Get user](/reference/integrations/highlevel/actions/get-user)
* [List campaigns](/reference/integrations/highlevel/actions/list-campaigns)
* [List workflows](/reference/integrations/highlevel/actions/list-workflows)
* [List forms](/reference/integrations/highlevel/actions/list-forms)
* [List form submissions](/reference/integrations/highlevel/actions/list-form-submissions)
* [List surveys](/reference/integrations/highlevel/actions/list-surveys)
* [List survey submissions](/reference/integrations/highlevel/actions/list-survey-submissions)