Ripe.identify

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

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.

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: {
        firstName: "Steve",
        lastName: "Jobs",
        email: "steve@apple.com",
    },
});

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

It's important to always 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, there are other reserved traits that we may use now or in the future so it's best to map appropriate data to them whenever it's available.

Reserved traitTypeDescription

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

Last updated