🔧Connect via API

How to send your events via the Ripe API

The API is ideal for sending updates to your entity's traits and other key info needed to properly segment your user base.

Authentication

All requests are authenticated using your API key. The API should be base64 encoded and sent in the Authorization header of your request, like this:

Authorization: Basic <base64 encoded key>

Identify

You should call Ripe.identify when you set a unique identifier for a lead/user, preferably an UID from your database. You should also call Ripe.identify every time a user either logs in or updates any of the attached traits e.g. email etc.

Identify a user

POST https://api.getripe.com/event/identify

Headers

NameTypeDescription

Authorization

String

Base64 encoded API key

Request Body

NameTypeDescription

anonymousId

String

Not required if userId is set

userId

String

Not required if anonymousId is set

messageId*

String

Unique message identifier

timestamp*

String

The event timestamp as a ISO-8601 date time string

traits

Object

Key-value pairs of user traits

context

Object

Key-value pair of contextual information. Only groupId is supported currently

Track

Use track calls to record what actions your lead/user performs in your products and on your websites. You can also attach properties contextual to the action taken.

Track events should be flattened whenever possible. For example, rather than Clicked button with Book a Demo as a property, use "Clicked Book a Demo Button".

Track a user action

POST https://api.getripe.com/event/track

Headers

NameTypeDescription

Authorization

String

Base64 encoded API key

Request Body

NameTypeDescription

anonymousId

String

Not required if userId is set

userId

String

Not required if anonymousId is set

messageId*

String

Unique message identifier

timestamp*

String

The event timestamp as a ISO-8601 date time string

event*

String

The event name

properties

Object

Key-value pairs of event properties

context

Object

Key-value pair of contextual information. Only groupId is supported currently

Page

Use page calls to track what pages your users visit. This is should be called on each page load in a traditional web page and on route changes in SPA applications.

Track a page visit

POST https://api.getripe.com/event/page

Headers

NameTypeDescription

Authorization

String

Base64 encoded API key

Request Body

NameTypeDescription

anonymousId

String

Not required if userId is set

userId

String

Not required if anonymousId is set

messageId*

String

Unique message identifier

timestamp*

String

The event timestamp as a ISO-8601 date time string

name

String

The page name

properties

Object

Key-value pairs of page properties

context

Object

Key-value pair of contextual information. Supports groupId and a nested 'page' object with the following properties: path, referrer, search, title and url

Group

This method is used to identify a workspace or account that a lead/user belongs to. The group_id is preferably an id from your database.

Identify a workspace/group

POST https://api.getripe.com/event/group

Headers

NameTypeDescription

Authorization

String

Base64 encoded API key

Request Body

NameTypeDescription

anonymousId

String

Not required if userId is set

userId

String

Not required if anonymousId is set

messageId*

String

Unique message identifier

timestamp*

String

The event timestamp as a ISO-8601 date time string

groupId*

String

The unique group identifier

traits

Object

Key-value pairs of group traits

Last updated