Ripe.identify

Set up to start sending your lead/users data to Ripe

You should call Ripe.identify under the following circumstances:

1. When you first set a unique identifier for a lead/user, preferably a UID from your database.

2. Every time a user either logs in or updates any of the attached traits, e.g., email, etc.

3. On each page load, this only needs to contain the UID.

Ripe.identify(identify_object)

identify_object: {
 userId?: string | null
 traits?: Record<string, unknown>
}

Here is an example of what you send could look like:

Ripe.identify({
    userId: "abc123ijk456",
    traits: {
        employees: "1-10",
        country: "Sweden",
        industry: "Technology/Audio Video",
        plan: "Trial"
    },
});

If a user_id is not provided, an automatically generated anonymous_id will be used.

Why add .identify on each page load?

A minimal version of the .identify with a UID as the only part of the object should be fired on each page load. While 1 & 2 ensure we have the correct metadata. The minimal call helps us keep tabs on users who come back to expired sessions without signing into the app and enables you to keep the stats and movements of the users up to date. It also makes the CRM integration perform optimally by checking that data in the CRM and Ripe are synced more frequently

Always send email when possible

It's important always to share email and format it like in the example whenever it's known. This enables us to enrich and group your leads into companies inside the Ripe app.

Reserved traits

In addition to email we may use other reserved traits now or in the future, so it's best to map appropriate data for them whenever it's available.

Reserved trait	Type	Description
address	Object	Street address of a user optionally containing: city, country, postalCode, state, or street
age	Number	Age of a user
avatar	String	URL to an avatar image for the user
birthday	Date	User’s birthday
description	String	Description of the user
email	String	Email address of a user
firstName	String	First name of a user
gender	String	Gender of a user
id	String	Unique ID in your database for a user
lastName	String	Last name of a user
name	String	It is reccomended to pass firstName and lastName for a lead. If you pass a first and last name Ripe automatically fills in the full name for you.
phone	String	Phone number of a user
title	String	Title of a user, usually related to their position at a specific company. Example: “VP of Product”
username	String	User’s username. This should be unique to each user, like the usernames of Twitter or GitHub.
website	String	Website of a user