Create Events

Create one or more events. Requires public API key in Bearer token.

curl --request POST \
  --url https://api.trench.dev/events \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [
    {
      "anonymousId": "guest-1234567890",
      "event": "UserSignedUp",
      "timestamp": "2021-01-01T00:00:00Z",
      "type": "track",
      "userId": "user-1234567890",
      "groupId": "group-1234567890",
      "properties": {
        "page": "/home",
        "referrer": "https://www.google.com"
      },
      "traits": {
        "email": "[email protected]",
        "name": "John Doe"
      },
      "instanceId": "customer-1234567890"
    }
  ]
}
'

POST

events

Create one or more events. Requires public API key in Bearer token.

curl --request POST \
  --url https://api.trench.dev/events \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [
    {
      "anonymousId": "guest-1234567890",
      "event": "UserSignedUp",
      "timestamp": "2021-01-01T00:00:00Z",
      "type": "track",
      "userId": "user-1234567890",
      "groupId": "group-1234567890",
      "properties": {
        "page": "/home",
        "referrer": "https://www.google.com"
      },
      "traits": {
        "email": "[email protected]",
        "name": "John Doe"
      },
      "instanceId": "customer-1234567890"
    }
  ]
}
'

This endpoint requires your public API key.

Trench is fully compatible with the Segment Spec schema. You can use the track, identify, and group methods to send events to Trench via the /events endpoint.

Body

application/json

events

object[]

required

The events to insert.

Show child attributes

events.anonymousId

string

The anonymous ID of the user. See anonymousId.

Example:

"guest-1234567890"

events.event

string

The event name. Used only with type: "track".

Example:

"UserSignedUp"

events.timestamp

string

The timestamp of the event. Autogenerated if not provided.

Example:

"2021-01-01T00:00:00Z"

events.type

string

The type of the event. Possible values: page, track, identify, group.

Example:

"track"

events.userId

string

The ID of the user.

Example:

"user-1234567890"

events.groupId

string

The ID of the group.

Example:

"group-1234567890"

events.properties

object

The properties of the event. Only used with type: "track".

Example:

{
  "page": "/home",
  "referrer": "https://www.google.com"
}

events.traits

object

The traits of the user or group.

Example:

{
  "email": "[email protected]",
  "name": "John Doe"
}

events.instanceId

string

Optional instance ID. Instance IDs are used to partition events by source. It is typically used for isolating data for the same customer. For instance, if you have a SaaS product, you may want to segment events by customer. In this case, you can set the instance ID to the customer's organizaiton ID.

Example:

"customer-1234567890"

Response

201

The events have been successfully created.

API Overview Get Events

⌘I

Overview

SDK and API

Events API

Webhooks API

Query API

Body

Response