ProductBird is super easy to get up and running with.
The first thing you need to do is install the widget on your website.
<head> tag (anywhere is fine) add the following:
This will automatically download and inject the ProductBird script. This will also create a
productBird object on the window, exposing the API.
The last step is to place a call to
productBird.init anywhere in your code, providing your
Once you have installed the widget, you can now start identifying your users so they start showing up in the dashboard.
To do so is easy, just call the
Below is an explanation of each field
|userId||string||true||A unique ID from your system that you can use to identify the user.|
|string||false||The users email address|
|firstName||string||false||Users first name.|
|lastName||string||false||Users last name|
|name||string||false||Users full name, for when you don't have a first name / last name|
|imageUrl||url||false||The users avatar. Must be a url (starting with https://)|
|joined||ISO8601 Date||true||The date the user joined the system, in ISO8601 format such as 2018-12-25|
|properties||object||false||A object containing key value pairs of properties that make sense to track in your product. These can also be used to segment the users. The values are all currentlytreated as strings. Some key / value pairs have a special meaning if supplied, see below details for what they are.|
There's also certain properties which if provided can give Kampsite more functionality. They are listed below:
|companyName||If your product has multiple users for a particular org/company use this to track the users of the same org|
|mrr||Month Recurring Revenue. The amount the user pays each month.|
|plan||The plan the user is currently on, if you have one.|
|role||The users role in the company, e.g. 'Founder'. This is important, especially if you want to segment based on this value|
Inits the ProductBird widget. You can also override settings and text from this function:
Where init opts is an object with the following structure:
Identifies the currently signed in user. See above for more examples.
Updates a specific user key / value pair. Creates it if it doesn't exist:
Updates multiple key / value pairs at the same time. Creates them if they don't exist.