Authenticate requests with your GHL API credentials and ensure the proper scopes (objects/schema.readonly for read operations and objects/schema.write for writes) are granted. Use secure storage for keys and rotate credentials regularly.
ActiveTrail authentication leverages API tokens issued to your app. Keep tokens secure, apply the principle of least privilege, and rotate credentials as part of your security practices.
1) GET /objects/:key — Retrieve a single object by key 2) GET /objects — List all objects 3) objects/schema.write — Create or update object schemas 4) objects/record.readonly — Read records with readonly access 5) GET /objects/:schemaKey/records/:id — Retrieve a specific record 6) objects/record.write — Write or update records 7) POST /objects/:schemaKey/records — Create new records 8) PUT /objects/:schemaKey/records/:id — Fully update a record 9) DELETE /objects/:schemaKey/records/:id — Delete a record
Trigger when you need to fetch object definitions or metadata; use GET /objects/:key to pull the schema and field details.
Actions: retrieve object metadata, map fields to ActiveTrail, and display results in dashboards or automations.
GET /objects/:key
Key fields: key, name, fields
Trigger: create or upsert records using POST /objects/:schemaKey/records when new data arrives.
Actions: create new records, update existing ones by key, and sync essential fields to ActiveTrail.
POST /objects/:schemaKey/records
Key fields: id, schemaKey
Trigger: update records with PUT /objects/:schemaKey/records/:id to replace field values as needed.
Actions: complete record replacement, versioning, and conflict resolution between systems.
PUT /objects/:schemaKey/records/:id
Key fields: id, schemaKey
Faster data sync between GHL and ActiveTrail without writing code or middleware.
Automations trigger on object changes to keep systems aligned in real time.
Schema-driven design makes onboarding, updates, and maintenance simple and scalable.
Elements: objects, schemas, records. Processes: authentication, mapping, syncing, error handling, and monitoring.
A named collection of fields representing a data type in GHL.
Defines the structure, fields, and validation rules for an object.
A single instance of an Object’s data, stored as a set of field values.
The URL path and HTTP method used to access or modify data in the API.
Automatically create or update ActiveTrail contacts when GHL objects change to keep campaigns current.
Reflect changes in either system to maintain data parity with minimal latency.
Version object schemas to enable safe rollbacks and controlled releases.
Obtain your GHL API key and set scopes to objects/schema.readonly for read access and objects/schema.write for writes.
Create and map your object schemas to ActiveTrail fields to align data models.
Run test calls against endpoints, verify data flow, handle errors, and deploy to production.
The Custom Objects API is a framework within GHL that lets you model and manipulate structured data as objects. It enables seamless data exchange with ActiveTrail, supporting lookups, reads, and writes of object schemas and records. By using object-oriented endpoints, you can organize data consistently and drive automations across both platforms. Leverage the No-Code benefits to accelerate integration work and reduce reliance on middleware, while maintaining a clean data model across systems.
Authentication uses your GHL API credentials with explicit scopes for reading or writing object data. Protect keys securely, rotate credentials regularly, and apply least-privilege access to minimize risk. ActiveTrail uses its own API tokens; store them securely and apply token rotation policies.
Available endpoints include reading and listing objects, reading and writing schemas, and full create/update/delete operations on object records. The core endpoints are GET /objects/:key, GET /objects, GET /objects/:schemaKey/records/:id, POST /objects/:schemaKey/records, PUT /objects/:schemaKey/records/:id, and DELETE /objects/:schemaKey/records/:id. Some endpoints may require different scopes depending on the action.
Yes. You can create new records with POST, update existing records with PUT, and delete records with DELETE. For updates, you can choose partial updates via the appropriate write endpoints, or replace entire records when needed.
You can achieve many common tasks without code by using the API endpoints to map fields and automate actions in ActiveTrail. For advanced use cases, light scripting or orchestrations can help, but the API provides robust capabilities to accomplish most integration needs with minimal coding.
Latency depends on network conditions and endpoint usage. In typical setups, near-real-time synchronization is achievable for internal workflows, with occasional retries for transient errors. Always implement retries and proper error handling in automations.
Error logs can be found in your GHL account under API activity and in ActiveTrail’s integration logs. Use these logs to trace failed calls, inspect response codes, and adjust mappings or credentials as needed.
Due to high volume, we will be upgrading our server soon!
Complete Operations Catalog - 126 Actions & Triggers
