Home > How to add the SnapEngage Get Contact OPEN API plugin
Categories: Integrations & Plugins
(Last Updated On: May 21, 2018)
With the Contact OPEN API plugin, you can provide additional information to your chat agents about the visitor they are currently chatting with. Below is an example of the difference between the default information provided to your agents, and one that has some custom information:
This information will typically come from your database or CRM using a special set up by your developers first. Once your API is ready and you have its URL available, you can then set up Contact OPEN API within your Admin Settings.
Simply, go to “Settings” > “Integrations” > “Plugins” and select the Get Contact OPEN API icon:
Next, click the “Enable Get Contact open API plugin” check box, followed by entering your System Name and URL.
Click the “Save” button and voila, your integration using Get Contact OPEN API is now complete.
The web service will only be called if and when SnapEngage associates the visitor with a valid email address (read: not firstname.lastname@example.org).
The web service you referenced here in the URL field will be called by SnapEngage through your choice of HTTP / HTTP GET request when either: a chat starts and the visitor’s email address is available, or while a chat is in progress and the visitor provides an email address during the chat.
SnapEngage will add the following parameters to the HTTP GET request:
- email: the email address of the chat visitor
- ip: the IP address of the chat visitor
- url: the URL (encoded) page the chat was initiated
- caseId: the Id of the current SnapEngage case (chat)
Here is an example, assuming you have set your URL as https://api.awesomecustomer.com/segetcontact:
Your web service should return some plain text content as you would like it shown to the chat agent. When using the web client, your text will be shown in the contact tab of the related chat.
Published January 18, 2012