Authenticate requests to the Users API using your API key and the required scope (socialplanner/tag.readonly). Store credentials securely and rotate keys regularly.
Authorize LiveAgent to access the Users API via the app connector, using OAuth or an API key as configured in your workspace. Test the connection after setup.
Endpoint 1: GET /social-media-posting/:locationId/tags — Retrieve tags for a location. Endpoint 2: POST /social-media-posting/:locationId/tags/details — Upsert or update tag details. Endpoint 3: socialplanner/statistics.readonly — Read-only access to statistics. Endpoint 4: POST /social-media-posting/statistics — Submit post statistics for processing. Endpoints 5–17 are available in the API but not all are required for this page. Example additional endpoints include: GET /social-media-posting/:locationId/tags/details, GET /social-media-posting/:locationId/summary, etc.
Trigger: When a new tag is created in LiveAgent, create or update the corresponding tag in the Users API.
Actions: Create or update tag in Users API; fetch tag details; log the sync for audit.
POST /social-media-posting/:locationId/tags/details
locationId, tagId, tagDetails
Trigger: Daily statistics via the Users API to update LiveAgent dashboards.
Actions: Retrieve statistics; store in LiveAgent; generate and surface reports.
POST /social-media-posting/statistics
date, locationId, metrics
Trigger: On demand bulk refresh of all tags for a location.
Actions: Retrieve all tags; upsert into Users API; validate data integrity.
GET /social-media-posting/:locationId/tags and POST /social-media-posting/:locationId/tags/details
locationId, tagList
Automates workflows with visual triggers and actions—no custom development required.
Enables real-time data sync for accurate, up-to-date dashboards and reports.
Improves support efficiency by surfacing current tag data and statistics in LiveAgent.
Key elements include API endpoints, authentication, data mapping, and error handling. Processes cover setup, testing, and maintenance of the LiveAgent–Users API connection.
A specific URL and HTTP method in the API that performs a defined action, such as retrieving tags or posting statistics.
The method by which the app proves identity and authorizes requests (API keys, OAuth tokens, etc.).
Standard methods for granting access to the API; choose the method supported by your GHL account and app.
A user-defined callback over HTTP that sends real-time data from one app to another when an event occurs.
Automatically sync new tag details from LiveAgent to the Users API to keep data fresh.
Aggregate daily posting statistics into a readable LiveAgent dashboard for teams.
Schedule regular bulk refreshes of tags to ensure accuracy across systems.
Obtain API keys or set up OAuth for LiveAgent to authenticate with the Users API.
Authorize the connection in the app and run a test to verify access to endpoints.
Create automations to keep tags and statistics in sync between LiveAgent and the Users API.
No-code automation makes this accessible to non-developers. You can set up triggers and actions in the app connector to move data between LiveAgent and the Users API without writing code. If needed, you can still customize mappings using simple field selectors. The system guides you through authentication and testing steps to ensure a safe integration.
For basic tag sync, start with the GET /social-media-posting/:locationId/tags to retrieve existing tags, and the POST /social-media-posting/:locationId/tags/details to upsert tag data. The statistics endpoints provide insights into post performance and can be wired into LiveAgent dashboards with minimal configuration.
Authentication is handled via your chosen method (API Key or OAuth). In the app, configure credentials, scopes, and token lifetimes, then test the connection to ensure secure access to endpoints.
Yes. Use a sandbox or staging environment to validate changes before pushing to production. The app connector supports test runs and mock payloads to safeguard live data.
Tag and statistics synchronization can be configured as a scheduled task or triggered by events in LiveAgent. The frequency depends on your needs, from real-time to hourly updates.
Common required fields for tag upserts include locationId, tagId, and tagDetails. Mapping these to your internal fields ensures data consistency across systems.
Endpoint paths are documented in the developer guide. Look for example payloads and curl commands to help you implement the connection. The app connector provides in-context guidance.
Due to high volume, we will be upgrading our server soon!
Complete Operations Catalog - 126 Actions & Triggers
