This preview of pull request 1639 is meant for internal use only.

Clearbit Enrichment Destination

Clearbit Enrichment quick info

Clearbit Enrichment accepts Identify calls. If you reference it in the Integrations object, call it “Clearbit Enrichment", or "Clearbit”.

Clearbit Enrichment accepts cloud-mode data from all Segment source types. It does not offer device-mode connections.

Clearbit Enrichment helps customers enrich and append real-time data to an email or domain, driving growth or powering your product with social data, location, job title, company size and technology.

This document was last updated on April 20th, 2018. If you notice any gaps, outdated information or simply want to leave some feedback to help us improve our documentation, let us know!

Getting Started

Before you start, make sure Clearbit Enrichment supports the source type and connection mode you’ve chosen to implement. You can learn more about connection modes here.

Web Mobile Server
📱 Device-mode ⬜️ ⬜️ ⬜️
☁️ Cloud-mode
  1. From the Segment web app, click Catalog.
  2. Search for “Clearbit Enrichment” in the Catalog, select it, and choose which of your sources to connect the destination to.
  3. In your Segment UI’s destination settings, enter your Clearbit secret API key (note: it should start with “sk_”). You can find this in the API section of your Clearbit dashboard.

To verify that the destination has been set up correctly, check the Debugger section of your Segment Source. Assuming everything is as it should be, you should start seeing Clearbit Enrichment data populate in the identify events – click on the specific event you’re interested in to see Clearbit Enrichment traits. These traits will now be available to other Segment destinations in your account. Notice that all Clearbit Enrichment traits are prefixed with clearbit_ to ensure they don’t conflict with existing traits.

Identify

If you’re not familiar with the Segment Specs, take a look to understand what the Identify method does. An example call would look like:

analytics.identify('pixar123', {
  email: "carl.fredricksen@example.com"
});

When you call identify with a userId and email trait - the latter must be present for Clearbit Enrichment to function properly - we’ll send the Segment spec to Clearbit so that they can enrich your data. Once Clearbit enriches your data, they will send back a new identify call to your Segment source (Clearbit will have access to your writeKey) with additional traits.

You can find details on what traits Clearbit Enrichment adds and exactly what will be in the enriched identify call on Clearbit’s site.

Troubleshooting

Clearbit Enrichment data is not populating

Double check that you have entered the secret key, not the public key Clearbit provides.

Personas

You can send computed traits and audiences generated using Segment Personas to this destination as a user property. To learn more about Personas, contact us for a demo.

For user-property destinations, an identify call is sent to the destination for each user being added and removed. The property name is the snake_cased version of the audience name, with a true/false value to indicate membership. For example, when a user first completes an order in the last 30 days, Personas sends an Identify call with the property order_completed_last_30days: true. When the user no longer satisfies this condition (for example, it’s been more than 30 days since their last order), Personas sets that value to false.

When you first create an audience, Personas sends an Identify call for every user in that audience. Later audience syncs only send updates for users whose membership has changed since the last sync.

Settings

Segment lets you change these destination settings from the Segment app without having to touch any code.

API Key

Enter your secret key (prepended with sk_) associated with your Clearbit account.

Adding Clearbit Enrichment to the integrations object

To add Clearbit Enrichment to the integrations JSON object (for example, to filter data from a specific source), use one of the following valid names for this integration:

  • Clearbit Enrichment

  • Clearbit

This page was last modified: 20 Oct 2020



Get started with Segment

Segment is the easiest way to integrate your websites & mobile apps data to over 300 analytics and growth tools.
or
Create free account