Home > Integration API (legacy XML)


(Last Updated On: )

About This Article

The purpose of this article is to provide a comprehensive overview of the Integration API .


Have a custom-built integration or third-party application you want chat data sent to? No Problem!

The SnapEngage API allows developers to easily interface SnapEngage with other applications, getting all the data you gather sent to the place you want to keep it. This transaction provides detailed information pertaining to the request and allows developers to recreate the request in the destination system.

SnapEngage can automatically POST events to an external URL when new requests are received for both offline and live chats.

Activate the API

  1. In the SnapEngage widget configuration, under the “Integrations” tab.
  2. Select the “Open API” icon.
  3. Enter the URL of where you want to receive the POST message when a new offline request or live chat is processed by SnapEngage. In the sections below, you can elect to have the transcripts sent via email to a destination of your choice.
  4. Once you are done making changes, just make sure to click the “Save” button at the very bottom of the page.

At this time, the event details will be ready to be to parsed out and into your system.

Event API details

When the API is activated and a new support request is received, SnapEngage will automatically send a POST transaction to the URL specified in the API configuration. The transaction provides details about the support request in an XML format (legacy) or JSON.

POST event details in XML:

  Chrome (6.0.472.63)
  Microsoft Windows 7
  United States

         Flash 10.0.45 Java 1.6     [email protected] Mon Oct 18 01:48:27 UTC 2010 test Hello, Mon Oct 18 01:48:32 UTC 2010 visitor Hi, Mon Oct 18 01:48:41 UTC 2010 visitor This is a test. [email protected] Mon Oct 18 01:48:49 UTC 2010 test ok. thank's for testing. 2 15  

Additional Information

source_id: Value of 1 when the SnapEngage interaction was an offline message, value of 2 when it was a manual chat, or value of 3 if it was a proactive chat.

retries: The target system needs to respond with and HTTP 200 to confirm that the event has been received and processed. In the absence of a successful HTTP response, SnapEngage will retry the HTTP POST automatically for approximately 2 hours before sending it through email and flagging the event as sent.

using PHP: The XML content is a stream in XML format. You can not access this stream in the $_* variables of PHP. Please use this instead:

$xml = fopen("php://input","r");

Did you find this article helpful?

Not HelpfulNeeds WorkSo-soHelpfulVery Helpful (4 votes, average: 3.75 out of 5)
Loading ... Loading ...

Published January 30, 2013

Reader Feedback

No comments yet

Add your thoughts