Clearbit

With our Clearbit integration, you can easily enrich the information provided by Zammad. If the customers or agents email address is known to Clearbit, it will share all information it has regarding the user with Zammad. Those information can include the following:

  • Avatar

  • Address information

  • Website information

  • A BIO (as Note by default)

If needed, you can add further custom objects and add mappings to them, so the clearbit information can be filled within the database. In general you can get any information from clearbit, as long as you have a mapping to an Zammad object.

Hinweis

Clearbit does have a Mapping of fields like LDAP and Exchange have, but does not „win“ against Zammad information. This means that if you have e.g. the lastname field filled in already and Clearbit has other information on that, it will not be updated.

However: If let’s say the lastname has been set by Clearbit and Zammad notices that the lastname on the Clearbit source has changed, Zammad will also update this value.

Configuration

The configuration of clearbit is really easy and done fast! Just login to your Clearbit-Account, go to „API“ and copy the secret-API-Key.

../../_images/api-key.jpg

Now change to your Zammad instance, go to Integrations (System) -> Clearbit in the admin panel. Paste your API-Key into the API-Key-Field and decide if Zammad should create unknown Organizations automatically, if the user does not have one yet (and Clearbit knows it). The shared option decides if the new organizations Zammad creates with Clearbit should be shared ones.

Bemerkung

If you’re unsure what option to choose, better stick with „no“. You can also learn more about Organizations.

../../_images/configure-zammad.jpg

The Mapping option works similar to the mapping within the Exchange and LDAP sync. You can add further mappings for e.g. custom fields if you need more information that Clearbit can provide.

Bemerkung

If you want to add more Clearbit fields and want to learn more about available fields on their API, you can take a look at their API documentation .

If you’re happy with the above chosen Settings and your mapping, just save the changes and enable Clearbit integration. Zammad will now start polling the Clearbit API as users contact you.

Bemerkung

Zammad does not synchronize with Clearbit on a regular basis, but on demand if needed. This saves API calls.

../../_images/zammad-mapping.jpg

Below the Settings and Mappings, you’ll find our Integration log. You can see what requests Zammad sent to Clearbit and also the APIs Response.

../../_images/zammad-log.jpg

By the way, you can also view the API log on the Clearbit website - the information seen is basically the same.

../../_images/api-log.jpg

Example when adding a user

To show you how fast information is added, we added a small Screencast below. This shows the creation of the User Alex from Clearbit. As we already set the lastname of Alex to „X“, Zammad did not update it. What Zammad did was to add further information it received from Clearbit. Really cool, right?

../../_images/automatic-user-additions.gif