Getting Started with Integrating your CRM


Consumer information captured in the Limelight database, can be pushed to other systems to ensure the information is easily accessible through internal systems already in place.
The path to successfully integrating Limelight with another system requires a thorough understanding of the current state, technical capabilities, and business rules.
As a start, send the Integration Requirements document to your Technical lead for review. We’ll work directly with your technical team on the specifics.
Our Process
  1. Project Scoping
    • Initial Call – meeting with your Technical lead, the focus of the call is to gain a detailed understanding of the overall project and technical requirements and capabilities to properly scope the time and costs associated with the integration. Questions typically addressed on this call include:
      • What current systems do you use today and how do they relate to the data captured in Limelight? (ex. Salesforce is our CRM and all consumer information must live in that system, from there the data is pushed to another system that is accessed by our retail network).
      • What are the business rules that apply to your data? (ex. If consumer opt-in = Yes, then send Marketing Newsletter’.
      • Are there any special consideration we should be aware of? (ex. filename is case sensitive and must be a .csv).
  2. Cost Estimate & Work-back Schedule
    • When the technical assessment and scoping requirements have been completed, a cost estimate will be sent for approval with an estimated timeline. Key considerations taken into account when preparing the estimate include:
      • Type of integration – fully custom solution or self-serve option
      • Complexity of the project (ex. number of fields to be integrated)
      • Client event start and end dates
      • Number of Limelight projects requiring integration setup
      • Integration team resourcing availability
    • Once the quote has been approved a detailed work-back schedule will be shared outlining key milestones.
  3. Integration Development & Testing
    • A Limelight project must be built in the platform with all identified fields in order for the integration to be setup with another system
    • Before integration development begins, a client final sign-off on all fields and business rules is needed to ensure no additional integration work is required later on in the project, which would impact delivery timelines and costs.
    • Working with the client’s CRM or integration developer, test leads are sent to verify the integration setup is working properly.
  4. Troubleshooting & Ongoing Maintenance
    • We will work with your teams to determine the cause of integration issues that may arise.
    • Simple updates to a completed integration setup can be made, however, system wide changes requiring a full review of the integration will require a new technical assessment and scoping exercise.

Integration Requirements

For a successful integration with the Limelight platform, our integration team requires the following information. Please send this document to your Operations/IT team responsible for the system(s) receiving Limelight data and send any questions to
For Operations/IT: Please send the following information to with the subject line: INTEGRATIONS: COMPANY NAME. Use the table below as your checklist.
1. XML, JSON, or sample output file containing all outputs that may receive data from Limelight Platform and a table explaining which field/element(s) of the xml file are mandatory and which ones are optional.
2. Workflow diagram or process document outlining how data is received and cleansed, and any restrictions or known limitations of your system with respect to values. Ex. Use of special characters, format for date and time values.
3. Hostname or URL of the staging/test servers and the associated credentials for each to verify the integration process is correct and no data is lost.
4. Hostname or URL of all production servers that the data will be going to and the associated credentials for each.
5. APIs we will use to interact with the CRM servers that are ingesting the data

a. The type of requests allowed for each API endpoint.
b. Parameters (if any) and their descriptions that are used by the API endpoints.
c. Expected response codes and associated messages for successful transfers and failed transfers.
6. Content type and a sample payload of what your CRM server expects

a. i.e. XML, JSON, CSV format type.
7. Specific fields that are required to be in the payload that the CRM server is ingesting

a) For each field, the integration team needs the name of the field, a description of the field, its data type, if it’s mandatory or optional, and a sample value.
8.Frequency of when new data should be sent from Limelight to the client’s CRM system run. Ex.Once a day, once a month, once an hour.
Field name expected by CRM System
description Data Type Mandatory/Optional Sample Value
first_name The first name of a potential lead String Mandatory Andrew
date_of_birth Date of birth Date Optional 01/31/1970

Still need help? How can we help? How can we help?