API Overview
Overview of the Trench API
Trench API Overview
The Trench API provides a comprehensive suite of endpoints to interact with the Trench platform. It is designed to be fully compatible with the Segment Spec schema, allowing you to seamlessly integrate and send events using familiar methods such as track, identify, and group.
Events
The /events endpoint allows you to create and retrieve events using the track, identify, and group methods. These methods enable you to send detailed event data to Trench, including user interactions, identity information, and group associations. For more information, refer to the Create Events and the Get Events documentation.
Queries
The /queries endpoint enables you to execute queries against the Trench platform. This allows you to retrieve and analyze data based on the events and interactions recorded. For more details, refer to the Execute Queries documentation.
Webhooks
The Trench API also supports webhooks, which allow you to receive real-time notifications about specific events or changes within the platform. You can create, retrieve, and delete webhooks using the respective endpoints. For more information, refer to the following documentation:
Authentication
The Trench API uses bearer token authentication to secure access to its endpoints. You will be issued a public api key and a private api key to use when making requests. The public key is used only in the Events endpoint to send data to Trench. It is safe to expose this key to the public internet.
The private key is used on all other endpoints and should be kept secret.
Note: Do not use your private API key on public endpoints. Always use your public API key to avoid unauthorized access and misuse.
Was this page helpful?