Updating a CRM (or Lead Generation) platform using CANDDi API [How to guide]

Follow


Summary:

This document describes how to keep your CRM platform (or other internal lead-generation / customer platform) updated with real-time information passed in from CANDDi.  

Essentially CANDDi sits as a "marketing" (or analytics) filter on top of your CRM platform.  When identified visitors (or identified companies if your platform supports this) perform pre-defined trigger actions on your website then CANDDi will capture this information and will real-time update your CRM platform with this information.  

Example:

  • When a Visitor first identifies themselves on your website (whether by filling on a form or clicking a link in an email) then update your CRM record for this Visitor with the total number of visits, pages viewed and duration on site so that your sales team know who is most engaged 
  • When an Identified Visitor first visits your pricing page then you could update your CRM platform to schedule them with a call-back.


NOTE: This initial document assumes that you have full control over your CRM platform (and/or that you can transform the CANDDi data to match your CRM's API formats).  CANDDi is currently developing out of the box CRM integrations for major CRM platforms.


Functional overview:


TODO DRAW PICTURE



The Workflow:



1. Triggers-

1.1 WebHook Trigger-
The WebHook Trigger is used to produce real-time updates from CANDDi to your system.  These updates will be triggered between 0.5-5 seconds after a Contact has entered a stream

See WebHook Trigger FAQ for details about the actual API call.



2. Linking the Contact profile within your platform-
CRM platforms generally have a unique identifier for a person record
(sometimes a CRM-Id, sometimes it's the email address).  

Once you've joined your "internal" identifier to the CANDDi identifier (either using the WebHook Trigger or the Search for Contact) then you can get the latest version of the CANDDi Contact data by calling the GET Contact API



3. Authentication-
CANDDi currently uses a shared API token in the HTTP header for authentication.  
(Note CANDDi is moving to using an oAuth based authentication system)

See: How do I get an API Token











Have more questions? Submit a request

Comments