Use OAuth to grant your SaaS API access to GHL resources. Scope includes oauth.readonly.
Connect APPNAME to your GHL account by completing the OAuth flow and securely exchanging tokens for API calls.
Used endpoints include GET /oauth/installedLocations to enumerate locations; POST /oauth/locationToken to exchange tokens; PUT /update-saas-subscription/:locationId to update subscriptions; POST /enable-saas/:locationId to enable the SaaS location; saas/location.write for location writes. Endpoints 7–17 are reserved for future use.
Triggered when a new location is installed and a token must be issued.
Actions: fetch installed locations (GET /oauth/installedLocations) and exchange tokens (POST /oauth/locationToken) to create a usable locationId.
GET /oauth/installedLocations
locationId, accessToken, refreshToken, expiresIn
Triggered when a SaaS location’s subscription changes.
Actions: update via PUT /update-saas-subscription/:locationId; enable via POST /enable-saas/:locationId.
PUT /update-saas-subscription/:locationId
locationId, planId, status
Triggered when tokens expire or endpoints report errors.
Actions: refresh tokens via POST /oauth/locationToken; monitor endpoint health.
POST /oauth/locationToken
locationId, token, refreshToken, expiration
Automate onboarding and data sync without writing code.
Centralized authentication and location management inside GHL.
Real-time visibility into location status and campaign triggers.
Glossary of terms used: GHL, APPNAME, OAuth, location, token, endpoint, and subscription, plus how they relate in this integration.
GHL is the CRM/automation platform whose API powers this integration.
APPNAME refers to ActiveCampaign Postmark, the application being connected to GHL.
An API endpoint is a specific URL you call to perform an action in the SaaS API.
OAuth is the authorization protocol that lets apps access GHL resources securely without sharing passwords.
Send onboarding emails automatically when a new location is connected.
Trigger campaigns when subscription status changes or renewals occur.
Create dashboards showing endpoint health, token freshness, and location activity.
Install the SaaS API app in GHL to begin the OAuth flow.
Grant oauth.readonly and any required permissions to access installed locations.
Configure location settings, test endpoints such as GET /oauth/installedLocations, and verify data flows.
SaaS API is the connector that enables your SaaS app to communicate with GHL via AppName. It handles authentication, token management, and data exchange so you can automate workflows without custom coding. This guide walks you through setting up OAuth, obtaining location tokens, and calling core endpoints to manage locations and subscriptions. Together with APPNAME, SaaS API provides a secure bridge between your app and GHL to empower automation, reporting, and lifecycle campaigns.
In this integration, GHL acts as the central platform that hosts the app connector and OAuth flow. It grants access to installed locations and tokens, and it exposes endpoints you call from APPNAME. This setup ensures data remains secure while enabling seamless automation across systems. You will primarily interact with endpoints like /oauth/installedLocations, /oauth/locationToken, /update-saas-subscription/:locationId, and /enable-saas/:locationId.
Key endpoints include GET /oauth/installedLocations for location discovery, POST /oauth/locationToken to exchange tokens, PUT /update-saas-subscription/:locationId to modify subscriptions, and POST /enable-saas/:locationId to activate a SaaS location. Additional endpoints under saas/* handle writes and management tasks as needed. End-to-end flows typically start with discovering locations, exchanging a token, then updating or enabling subscriptions as required.
No-code is supported for many tasks via the GHL UI and App Connector. You can configure OAuth scopes, map location fields, and set up subscription rules without writing code. Some advanced customizations may still require small script steps or automation rules within GHL. For most setups, the built-in endpoints and visual builders are sufficient to connect and automate.
This guide focuses on live production flows, but you can often test in a sandbox or staging environment if provided by the SaaS API. Check your developer portal for any test credentials or pilot locations before going live. Always validate OAuth scopes and endpoint responses in a safe environment before deploying to production.
Status can be monitored through endpoint health checks, token expiry alerts, and activity logs within GHL and APPNAME. You can set up automated notifications for token expiry, location changes, and subscription updates to stay informed in real time. Regular health dashboards help you quickly identify and resolve issues before they impact campaigns.
Due to high volume, we will be upgrading our server soon!
Complete Operations Catalog - 126 Actions & Triggers
