Getting started with Clearbit.js
Clearbit.js is a client-side javascript library makes it easy to send data from your website to Clearbit. With this library, you can send page views and pertinent custom person or company traits to Clearbit, which is used for Clearbit X.
Add the clearbit.js snippet to your website html
Next, add any domains that you'll be loading Clearbit tags on to the Allowed Referrers list. This is a security measure that will ensure your public API key won't be used on any other sites.
If you just want to send your web traffic to Clearbit X, you're all done! Visit your Clearbit Companies Dashboard to see your live web traffic.
If you want to be more precise about which known people (as opposed to which companies) are on your site at a given time, as well as to be able to create people segments and destinations, you'll want to identify your users.
Identify your users
Identifying users allows clearbit.js to associate custom user traits to page view events and Clearbit X to create people segments. Note that clearbit.js uses cookies to save all of this data to the session.
The `identify` method is how you associate your users, their page views, to a recognizable `user_id` and `email`.
Here is the `identify` method definition:
clearbit.identify([userId], [traits]);
The `identify` call has the following fields:
Here's an example of a basic `identify` call:
clearbit.identify("77e21cfd-2198-4000-944c-529097fc7019", {
email: "alex@clearbitexample.com"
});
Wait a moment! When you copy and paste the above code on your site, you’ll need to replace all those hard-coded strings with details about the currently logged-in user.
We suggest using a backend template to inject an `identify` call into the footer of every page of your site where the user is logged in. That way, no matter which page they're on, they will be identified.
Depending on your templating language, it might look something like this:
clearbit.identify('{{ user.id }}', {
email: '{{ user.email }}'
});
Traits
The traits is a dictionary of values that is associated with the user and subsequent page view events.
Note that traits can be totally customizable. However, there are specific traits that Clearbit treats a bit differently.
The traits will end up in your Clearbit X as such:
Troubleshooting
The best way to troubleshoot clearbit.js is to take a look at your browser's developer console. The console allows you to write javascript and execute methods manually. You also can inspect the Network Tab in the developer console to view requests going from the browser to Clearbit's servers.
Are you loading `clearbit.js`?
Open the javascript console. Type in `clearbit` and hit enter.
If you see the data type being loaded, then it's working! Otherwise, it means that clearbit.js is not being loaded onto the website.
Have you listed your domain(s) in Allowed Referrers list?
The Allowed Referrers list tells Clearbit which domains to accept requests from. If it's not in this list, then Clearbit will not accept requests from that domain.
What's next?
Clearbit X is as good as the data you provide it. To level up your data:
After you've added your data sources, then:
Clearbit