Cloud Quickstart

In this guide, we’ll walk you through the process of sending your first event and reading it back using the Trench Cloud API. The example uses the Trench JavaScript client, but the same can be achieved by calling the Events API directly.

Getting Started

To get started with Trench Cloud, you need to sign up at app.trench.dev. Then, locate the necessary credentials in the API Keys tab.

Install Trench JavaScript Client

Next, install the Trench JavaScript client using your favorite package manager:

npm install trench-js

Alternatively, you can use the hosted version via the script tag below and skip the Initialize the Client step:

<script>
  (function(d,w){if(!w.Trench){w.Trench=function(c){var i={_config:c,_q:[]},m=["track","page","identify","group","getEvents","executeQueries"];m.forEach(function(f){i[f]=function(){i._q.push([f,arguments])}});return i;}; 
  window.trench=new Trench({
    publicApiKey: 'YOUR_PUBLIC_API_KEY',
    serverUrl: 'YOUR_SERVER_URL', 
    autoCaptureEvents: true
  });
  var s=d.createElement("script");s.type="text/javascript";s.async=!0;s.src="https://cdn.jsdelivr.net/npm/trench-js@latest/dist/trench.min.js";
  s.onload=function(){var r=new Trench(trench._config);trench._q.forEach(function(q){r[q[0]].apply(r,q[1])});w.trench=r;};
  d.getElementsByTagName("head")[0].appendChild(s);}})(document,window);
</script>

Initialize the Client

After installing the client, you need to initialize it with your API key. Replace YOUR_API_KEY and YOUR_SERVER_URL with the actual API key and server URL you received:

import Trench from 'trench-js'

const trench = new Trench({
  publicApiKey: 'YOUR_PUBLIC_API_KEY',
  serverUrl: 'YOUR_SERVER_URL'
});

Optionally, you can identify a user with the identify method:

trench.identify('user-id', {
  email: 'test@example.com',
  // Add any other traits you want to associate with the user
})

Send a Sample Event

Now you can send a sample event to Trench Cloud. Here is an example of how to send an event:

trench.track("Test Event");

This will send an event with the name Test Event.

Verify the Event

You can verify that the event was received by opening the Events tab in the Trench Cloud dashboard.

Going Further

Now that you’ve sent your first event, you can learn more about the many things you can do with Trench.

Overview

Guides

SDK and API

Events API

Webhooks API

Query API

Cloud Quickstart

Getting Started

Going Further

Get Events API →

Create Events API →

Webhooks API →

Query API →

​Getting Started

​Going Further

Get Events API →

Create Events API →

Webhooks API →

Query API →

Getting Started

Going Further