HighLevel

automations/highlevel-new-contact-follow-up.automation.ts

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

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.

Built-in triggers

Built-in actions

Runtime utilities

Integrations

Connect with OAuth

Connect with a Private Integration Token

Exports

Triggers

Actions

​Connect with OAuth

​Connect with a Private Integration Token

​Exports

​Triggers

​Actions

Connect with OAuth

Connect with a Private Integration Token

Exports

Triggers

Actions