Fl0 SDK.

Note

This SDK is to be used in conjunction with the Fl0 Snippet. They do not work independently.

Installation

npm install fl0-sdk

Usage

This SDK exposes two functions, group and identify.

Identify

// import the identify function
import { identify } from 'fl0-sdk';

// call the identify function where appropriate in your code
identify({
    // required
    userId: 'user1',
    // name is optional
    name: 'Conor',
    // email is optional
    email: '[email protected]',
    // optional object of key value pairs
    traits: {
        age: 21
    }
});

Track

// import the track function
import { track } from 'fl0-sdk';

// call the track function where appropriate in your code
track({
    // required
    type: 'Signed Up',
    // optional object of key value pairs
    properties: {
        plan: 'Enterprise'
    }
});

Group

// import the group function
import { group } from 'fl0-sdk';

// call the group function where appropriate in your code
group({
    // required
    groupId: 'group1',
    // required. This can be either 'company' or undefiend
    type: 'company',
    // required
    groupName: 'Nasa',
    // optional object of key value pairs
    traits: {
        employeeCount: 42
    }
});

Note that the group function only works after you have called the identify function.

Environment

Both Group and Identify functions take an optional second argument, a string which can either be 'development' or 'production'. This is used to determine which environment the SDK is running in and which API it will interact with. If no environment is provided, the SDK will default to 'production'.

Example:

// import the identify function
import { identify } from 'fl0-sdk';

// call the identify function where appropriate in your code
identify(
    {
        // required
        userId: 'user1',
        // name is optional
        name: 'Conor',
        // email is optional
        email: '[email protected]',
        // optional object of key value pairs
        traits: {
            age: 21
        }
    },
    'development'
);