Ripe
Search…
⌃K

Reference

Learn how to use the Ripe SDK to track key events and surface great prospects
The Ripe SDK is based on the Segment specification.
For more detailed documentation of each method, head over to Segment. If anything is unclear please email us.

Ripe.init(api_key, options)

This method should be called first in order to initialise the SDK.
/**
* api_key: Your organizations API Key
* options: Options for the widget
*/
Ripe.init("<api_key>", {
/**
* position: Where to display the widget
* Default: 'bottom-right'
*/
position: 'bottom-left' | 'bottom-right' | 'top-left' | 'top-right',
/**
* colors: What colors the widget should use
* Default: { primary: '#07D2C3', secondary: '#000000' }
*/
colors: {
primary: '#07D2C3',
secondary: '#000000'
},
/**
* When a video call is active we don't want to drop
* connection because a link triggers a page load.
*
* undefined: Nothing happens. Widget is displayed as is.
* If a page refresh occurs the video call
* will drop.
*
* 'iframe': Widget will wrap the entire page in an iframe.
* This makes sure the call will stay connected
* even when a page load happens.
*
*
* Default: undefined
*/
mode: 'iframe' | undefined
})

Ripe.identify(user_id, traits)

When you have a unique identifier for a user, preferably an id from your database, this should be called. Typically when a user logs in or updates her email etc.
If a user_id is not provided an automatically generated anonymous_id will be used.
1
/**
2
* user_id: optional The unique identifier of the user
3
* traits: optional Traits of the user, eg. { firstName: 'Bob' }
4
*/
5
Ripe.identify("<user_id>", {})

Ripe.group(group_id, traits)

To connect a user to a group you should call this method. The group_id is preferably an id from your database.
/**
* group_id: required: The unique identifier of the group
* traits: optional: Traits of the group, eg. { name: 'Ripe' }
*/
Ripe.group("<group_id>", {})

Ripe.track(event, properties)

Use track calls to track what actions your user perform along with properties related to the track call.
/**
* event: required: The name of the event. Eg. "Clicked primary button"
* properties: optional: Properties of the track-call, eg. { text: 'Check out' }
*/
Ripe.track("<event>", {})

Ripe.page(category, name properties)

Use page calls to track what pages your users sees. This is typically called on each page load in a traditional web page and on route changes in SPA-applications.
/**
* category: optional: Category for similiar pages. For example the product page of
* an e-commerce site. Eg. "Product page"
*
* name: optional: The name of the page. Eg. "Signup"
*
* properties: optional: Properties of the page-call.
* Eg. { url: 'https://getripe.com' }
*/
Ripe.track("category", "name", {})

Ripe.alias(user_id)

Connects a new unique id to an existing identified user.
/**
* user_id: required: The new id this user goes by.
*/
Ripe.alias("<user_id>")

Ripe.alert()

Triggers a notification for this user. This will send a slack notification where you can start a "call" with this user.
This method will be removed in (a near) future in favor for setting up a workflow in our app.
Ripe.alert()
Last modified 1mo ago