Custom/in-house CRM integration

This article explains IntelliTicks' capability to integrate with your customized

IntelliTicks can be integrated with your custom CRM. For that you need to provide API details.

When IntelliTicks captures email or phone number, it will make an API call to your system to create the lead. Subsequently when other profile data is captured on chat, it will make API calls to update the lead. Below are the API requirements. Below are the requirements:

  • All API calls should have accept JSON payload/FORM post in the request body.

  • Optionally you can authorize your API calls with fixed Authorization keys in headers, query string or body.

  • Follow one of the given method to update the lead

    • Create a separate API calls to create the lead and update the lead. In create API return lead id in JSON body, which will be used in subsequent update calls.

    • Create just one API call and write a logic on server which reads email id and phone number from payload and identifies from the database if its new lead or existing lead.

Below are the sample API calls which would be made from IntelliTicks server

post
Create Lead

https://api.yourcompany.com/v1/lead
You can create endpoint like to this to create a lead in your CRM.
Request
Response
Headers
Authentication
optional
string
Authentication token
Body Parameters
param1
optional
string
Any custom field which is captured on chat.
name
optional
string
Name of the lead
phone
optional
string
mobile number of the lead
email
optional
string
Email id of the lead
200: OK
Lead created successfully
{
"id": "62839"
}

put
‚Äč

https://api.yourcompany.com/v1/lead/:id
You can create this endpoint to update the lead in your CRM
Request
Response
Path Parameters
id
optional
string
Lead id of a lead which is being updated
Headers
Authorization
optional
string
Authentication token
Body Parameters
param1
optional
string
Additional field to update for the given lead
param2
optional
string
Additional field to update for the given lead
200: OK
Lead updated successfully
{
"id":"62235"
}

Once you are ready with the API endpoints, please share the same with your point of contact to get it updated.