Support Portal

Search our knowledge base or get in touch

basic

advanced

Exact phrase:

  • Home
  • Categories
  • Sign in
  • Home
  • Categories
  • |
  • Submit a ticket
  • Sign in
  1. Home
  2. Streaming API - Eventing API (Webhooks)
  • General Questions 20 Articles

    • Billing and Pricing 2 Articles
      • LiveHelpNow pricing schedule
      • Cancellation policy
    • Services and Features 31 Articles
      • Integration with other CRM systems
      • Custom information feed
      • Why LiveHelpNow Help Desk Software is Different
      • LiveHelpNow proprietary Whisper Technology
      • Is there a limit to the number of chats I can have each month?
      • Can I place chat buttons on more than one site/domain?
      • Visitor Tracking
      • Mobile Chat - Live Chat for Mobile
      • SMS Chat with landline phone. Under the hood
      • LiveHelpNow Prohibited Content & Commerce Statement
      • Banning IP Addresses
      • Occupancy and Utilization Report
      • Analyze Campaign Data (UTMs) in relation to number of page views, chat sessions and conversions.
      • KB Updates for April 26th, 2022
      • Time Duration in Excel
      • SMS Chat. Supporting customers who like to text.
      • Integration with Google Analytics & Google AdWords
      • How to setup live chat queuing for call centers
      • How LiveHelpNow Systems Work Together
      • Mail Profile Setup - Email "From" address setup
      • KPI Dashboards Set-Up
      • Email-Ticket Management system description
      • Chat, Ticket, Call tagging explained
      • Using the LiveHelpNow Real-Time Language Translator
      • How to Setup Visitor Automations and Lead Scoring
      • Sentiment Analysis
      • Operators explained
      • Outsource customer service to a BPO
      • LiveHelpNow Analytics Report List
      • Streaming API - Eventing API (Webhooks)
      • Salesforce Integration for LiveHelpNow Chat System
    • Security and Privacy 5 Articles
      • LiveHelpNow PCI certification, HIPAA compliance, and Safe Harbor compliance
      • GDPR
      • LiveHelpNow Cookie Policy
      • Recommended LiveHelpNow chat settings for HIPAA, PCI compliance
      • Live Chat in California
    • Can my agents handle multiple chats at a time?
    • How many web agents does my site require?
    • Why LiveHelpNow Help Desk Software is Different
    • Is there a limit to the number of chats I can have each month?
    • I have multiple web sites I would like to support. Is this possible with LiveHelpNow ?
    • Chatting with multiple customers at the same time
    • Visitor's raw log data storage
    • LiveHelpNow Prohibited Content & Commerce Statement
    • LiveHelpNow Section 508 Compliance & Accessibility for Visually Impaired Users
    • Live Chat in California
    • Occupancy and Utilization Report
    • Time Duration in Excel
    • KPI Dashboards Set-Up
    • Email-Ticket Management system description
    • Adding Watchers to Tickets
    • Are there any limitations in the Trial account?
    • Sentiment Analysis
    • Operators explained
    • What is LiveHelpNow? Why should i choose LiveHelpNow for my business?
    • Salesforce Integration for LiveHelpNow Chat System
  • Getting Started 13 Articles

    • Installation 10 Articles
      • How to customize LiveHelpNow
      • Automatic Department Routing
      • Live chat installation on multiple websites
      • Installation in Wordpress
      • How to upgrade LiveHelpNow WIndows App.
      • How to install the live chat system on your website
      • BigCommerce Plugin Installation Guide
      • Installing LiveHelpNow on Magento
      • I have Google Tag Manager (gtm), Google Analytics Classic (gaq) and Universal Google Analytics (ga), but it always defaults to ga with the embedded window
      • Integrating Google Tags Manager with the embedded window
    • Training Resources 18 Articles
      • LiveHelpNow proprietary Whisper Technology
      • How to Search Chat History
      • How do I view the Browsing History for a visitor?
      • Chatting with multiple customers at the same time
      • Accepting and transferring chats
      • How to add canned messages
      • Occupancy and Utilization Report
      • Time Duration in Excel
      • Creating and administering Live Help Bot
      • Changing customer provided chat information
      • Adding Watchers to Tickets
      • How to view closed tickets
      • Email-Ticket Workflow
      • How to Generate Reports On-Demand
      • Callbacks Workflow
      • Using the LiveHelpNow Real-Time Language Translator
      • Abandoned live chat requests. Causes and solutions.
      • Outsource customer service to a BPO
    • Account Setup 7 Articles
      • Recommended LiveHelpNow chat settings for HIPAA, PCI compliance
      • Assigning Administrators and choosing extra permissions for operators
      • Managing Departments
      • How to do a "unattended / silent installation" so you can push the LiveHelpNow Alerter software to client computers remotely
      • How to Setup Support Ticket Automations
      • Department Isolation
      • Operator Auto Logout Settings
    • How to customize LiveHelpNow
    • How to Search Chat History
    • How do I view the Browsing History for a visitor?
    • Chatting with multiple customers at the same time
    • Occupancy and Utilization Report
    • Creating and administering Live Help Bot
    • How to Generate Reports On-Demand
    • Steps to upgrade your trial
    • Offline window settings
    • Operators explained
    • Firewall setup for LiveHelpNow service
    • I have Google Tag Manager (gtm), Google Analytics Classic (gaq) and Universal Google Analytics (ga), but it always defaults to ga with the embedded window
    • Integrating Google Tags Manager with the embedded window
  • Customization 16 Articles

    • Live Chat System 37 Articles
      • Trigger chat invitations
      • Customizing system messages used in a chat conversation
      • System chat messages customization - Welcome message
      • Mobile Chat - Live Chat for Mobile
      • Live chat installation on multiple websites
      • Call Deflect
      • Banning IP Addresses
      • Recommended LiveHelpNow chat settings for HIPAA, PCI compliance
      • Live Chat in California
      • Email Transcripts
      • Connecting Twilio Messaging with your LiveHelpNow account
      • Supporting customer via text
      • SMS Chat. Supporting customers who like to text.
      • How to setup live chat queuing for call centers
      • Creating and administering Live Help Bot
      • How to export chat transcripts for your records
      • Decrease wait time for customers before chat is accepted
      • Mail Profile Setup - Email "From" address setup
      • New visitor notification
      • Chat, Ticket, Call tagging explained
      • Managing Operator View Access
      • How to send visitors their chat transcript by email and include a survey
      • Chat Session Timeout
      • How to Setup Visitor Automations and Lead Scoring
      • Live Chat Skill routing and overflow
      • Right-to-left language support
      • Exchange of confidential information in chat or ticket
      • Perform an action in a custom code before chat launch
      • Dynamic Department Routing
      • "Live chat is currently unavailable" message
      • Importing Canned and Knowledge base content from other systems
      • New visitor notification
      • Department Isolation
      • How to set up department routing via pre-chat requirements
      • Chat System Customization
      • Showing operator photo in chat
      • How to Setup a Post Chat or Ticket Survey
    • Ticket System 16 Articles
      • Allow customers to submit inquiries via URL, link
      • Activating post ticket survey
      • Mail Profile Setup - Email "From" address setup
      • Add customer satisfaction surveys to your ticket responses and resolutions
      • Adding Watchers to Tickets
      • Managing Ticket-Email Notifications
      • Supporting multiple brand with email-ticketing system
      • How to Setup Support Ticket Automations
      • Right-to-left language support
      • Exchange of confidential information in chat or ticket
      • Ticket SLA and Reminders
      • Importing Canned and Knowledge base content from other systems
      • How to setup Email-to-Ticket integration
      • Dealing with SPAM
      • Ticket Autoresponder Email Templates
      • Using LiveHelpNow Support Ticket Software for Drip marketing (Lead nurture)
    • Knowledge Base 13 Articles
      • Publish knowledge base system by pointing CNAME record for your domain
      • Hiding [Sign In] link within support portal header
      • Embed video content within an article
      • KB Updates for April 26th, 2022
      • Content blocks explained
      • Gain SEO benefit for your main website domain after publishing a support portal or Knowledge Base
      • Configuring the Customer Support Portal
      • Setting Up Multiple Knowledge Bases
      • Knowledge Base Update - June 2021
      • How to customize the look of the published Knowledge Base
      • How to add articles to the Knowledge Base
      • Importing Canned and Knowledge base content from other systems
      • How to publish Knowledge Base system
    • Embedded Widget 3 Articles
      • Customization options for the Embedded Widget
      • CSS customization of the Embedded Widget
      • Hiding embedded widget when all agents are offline
    • Workforce Management 2 Articles
      • Workforce management - Shifts and Holidays
      • Occupancy and Utilization Report
    • How to customize LiveHelpNow
    • Live chat installation on multiple websites
    • Pre and Post inquiry Customer satisfaction surveys
    • Integration with Google Analytics & Google AdWords
    • Creating and administering Live Help Bot
    • Configuring the Customer Support Portal
    • Setting Up Multiple Knowledge Bases
    • How to send visitors their chat transcript by email and include a survey
    • Exporting leads in Auto-Lead Data Format (ADF XML)
    • Offline window settings
    • Operators explained
    • Right-to-left language support
    • Exchange of confidential information in chat or ticket
    • Adding & Updating Operators
    • Customize with different languages
    • Salesforce Integration for LiveHelpNow Chat System
  • Advanced Customization 18 Articles

    • Adv Installation 3 Articles
      • Install LiveHelpNow widget on Shopify.
      • Routing chat to individual operators
      • Integrating LiveHelpNow into Google Tag Manager
    • Adv Troubleshooting 3 Articles
      • My browser notification do not show for LiveHelpNow events
      • Unable to upload files while using LiveHelpNow Windows App
      • Troubleshoot: Keep going offline issue.
    • Adv Customization 8 Articles
      • Embeddable Widget SDK
      • Allow customers to request callback via URL, link
      • Building SMS Chat bot
      • Mapping the flow for your Live Help Bot
      • Live Chat Skill routing and overflow
      • Ticket SLA and Reminders
      • Dealing with SPAM
      • Embedded Widget - Enable names and Times for Each Chat message
    • Integrations 23 Articles
      • Custom information feed
      • Google Business Messages Integration
      • MS Teams Integration
      • Slack Integration
      • Developers: LiveHelpNow API
      • Embedded Widget - Optional Mobile tweks
      • Installation within a mobile app
      • Integration with Sage
      • Connecting Twilio Messaging with your LiveHelpNow account
      • Facebook integration
      • Supporting customer via text
      • SMS Chat. Supporting customers who like to text.
      • Integration with Google Analytics & Google AdWords
      • How to export chat transcripts for your records
      • Using LiveHelpNow Events with Google Tag Manager
      • Facebook integration troubleshooting
      • Integration with ZenDesk
      • Exchange of confidential information in chat or ticket
      • I have Google Tag Manager (gtm), Google Analytics Classic (gaq) and Universal Google Analytics (ga), but it always defaults to ga with the embedded window
      • Integrating Google Tags Manager with the embedded window
      • Streaming API - Eventing API (Webhooks)
      • Using LiveHelpNow Support Ticket Software for Drip marketing (Lead nurture)
      • Salesforce Integration for LiveHelpNow Chat System
    • HelpOut Tab 1 Articles
      • Supplying already known pre-chat fields
    • Chat Buttons 3 Articles
      • Install live chat as a link
      • Custom Live Chat Buttons
      • Supplying already known pre-chat fields
    • Chat Windows 4 Articles
      • Redirect to custom offline window when all operators are offline
      • Customizing chat windows for different languages
      • Mail Profile Setup - Email "From" address setup
      • Supplying already known pre-chat fields
    • Chat Invitations 1 Articles
      • Trigger chat invitations
    • Install live chat as a link
    • Trigger chat invitations
    • Custom information feed
    • Redirect to custom offline window when all operators are offline
    • Custom Live Chat Buttons
    • Two-Factor Authentication (MFA, 2FA)
    • Configuring SSO in Azure AD
    • Configure SSO in Google SAML
    • How to export chat transcripts for your records
    • Using LiveHelpNow Events with Google Tag Manager
    • Exchange of confidential information in chat or ticket
    • Perform an action in a custom code before chat launch
    • Dynamic Department Routing
    • Dealing with SPAM
    • I have Google Tag Manager (gtm), Google Analytics Classic (gaq) and Universal Google Analytics (ga), but it always defaults to ga with the embedded window
    • Integrating Google Tags Manager with the embedded window
    • Streaming API - Eventing API (Webhooks)
    • Supplying already known pre-chat fields
  • Troubleshooting 24 Articles

    • Live Chat auto invitations do not appear when testing
    • Time Duration in Excel
    • Troubleshooting Android App notifications
    • Published knowledge base articles display incorrectly
    • Why is there a message when installing the Alerter that says: "Object already exists"?
    • Using traceroute to diagnose network routing issues
    • Find Alerter notification software icon in Windows 7
    • Hardware Firewall SonicWall Issues
    • How to determine if your network has issues connecting to LiveHelpNow
    • Error: "There is a problem with this Windows Installer package. A DLL required for this install to complete could not be run. Contact your support personnel or package vendor"
    • Using LiveHelpNow Events with Google Tag Manager
    • Viewing Exported CSV files containing Arabic characters
    • New visitor notification
    • The installer was interrupted before LiveHelpNow could be installed. You need to restart the installer to try again.
    • Hiding embedded widget when all agents are offline
    • This installation package could not be opened
    • There is a problem with this Windows installer package. A DLL required for this install to complete could not be run.
    • LiveHelpNow operator panel loads slowly, shows "Page not found" errors or freezes.
    • How to fix audio notifications for LiveHelpNow Windows App
    • "Live chat is currently unavailable" message
    • LiveHelpNow Windows App MSI installer fails with error 2503 and 2502
    • Windows App (Alerter) is showing "Connecting to notifications" message
    • Troubleshooting live chat button status
    • Forgot Password
  • Security and Compliance 3 Articles

    • LiveHelpNow Data Protection and Storage
    • Configuring SSO in Azure AD
    • Configure SSO in Google SAML

Popular Knowledge Base Articles

  • Integration with other CRM systems
    • 23430
    • 57
  • How many web agents does my site require?
    • 25215
    • 59
  • Custom information feed
    • 35320
    • 29
  • Install live chat as a link
    • 33340
    • 62
    • 0

Streaming API - Eventing API (Webhooks)

  • Date updated 2021-06-01
  • Comments 0
  • Rating
  • Categories
  • Services and Features
  • Advanced Customization
  • Integrations
  • Tags
  • API
  • Integration
  • eventing
  • streaming
  • webhooks

Is there a way for LiveHelpNow to push customer data such as Name, Email, Chat transcript, Offline message, etc. to my contact management system automatically, in realtime?

* This article should be read by a developer in your organization

 

 
Introducing LiveHelpNow Eventing API (Webhooks)
No more manually calling an API, no more transfer delays, and no more frustrated developers. Eventing, which acts as a Streaming API, will allow you to receive fully customizable data and push it to any resource on the web at the exact moment a LiveHelpNow event such as a chat starting or a chat closing occurs.


 
 
How does LiveHelpNow Eventing API work?
 When an event you have subscribed to, such as "Chat Opened", "Chat assigned", "Chat Closed", "Offline Message", etc. occurs for your account, a payload is constructed per your instructions with data formatted in the way you want and is sent to the resource on the web you have setup to receive the payload and process it.


 
 
I'm excited! How do i set it up?
  1. Login to your account and go to Admin Panel->Integrations & Partners -> Webhooks 

  2.  Click on "Add Event"
  3. Select Event, Event Type, Verb, Headers (optional), Construct your payload by clicking on available tokens for the event.
    Provide URL to submit the data to.

    * We highly recommend to enable "Test" mode for the event and test the event first. While in test mode, the Event will email you the PayLoad so you can see whether the format is what you expected and then switch Event to live mode by unchecking "Test" mode and have the data sent to your "Live" URL for processing.
    Eventing API setup

 

How do i properly receive the data?
The PayLoad is sent as InputStream
Here's PHP example on how to receive InputStream data:
<?php

// To access your headers being sent
$headers = array();
foreach($_SERVER as $headerName => $headerValue){
	if(substr($headerName, 0, 5) == "HTTP_"){ // This will eliminate no request headers
		array_push($headers, array($headerName, $headerValue));
	}
}
// The $headers variable will now contain all HTTP Request headers within a multidimensional array

// The variable below with get the payload from the LiveHelpNow Eventing API 

$payload = $HTTP_RAW_POST_DATA;

?>
Here's ASP.NET example showing reception of InputStream.
VB
Private Function RequestInputStreamToString(oStream As System.IO.Stream) As String
        Dim sb As New System.Text.StringBuilder()
        Dim streamLength As Integer
        Dim streamRead As Integer

        streamLength = Convert.ToInt32(oStream.Length)
        Dim streamArray As [Byte]() = New [Byte](streamLength - 1) {}

        streamRead = oStream.Read(streamArray, 0, streamLength)

        For i As Integer = 0 To streamLength - 1
            sb.Append(Convert.ToChar(streamArray(i)))
        Next

        Return sb.ToString()
End Function


Response.Write(RequestInputStreamToString(Request.InputStream))
C#
private string RequestInputStreamToString(System.IO.Stream oStream)
{
	System.Text.StringBuilder sb = new System.Text.StringBuilder();
	int streamLength = 0;
	int streamRead = 0;

	streamLength = Convert.ToInt32(oStream.Length);
	Byte[] streamArray = new Byte[streamLength];

	streamRead = oStream.Read(streamArray, 0, streamLength);

	for (int i = 0; i <= streamLength - 1; i++) {
		sb.Append(Convert.ToChar(streamArray[i]));
	}

	return sb.ToString();
}

Response.Write(RequestInputStreamToString(Request.InputStream))
 
 
The following is the complete list of data values available to be sent with a payload for each event type:
 
Chat Opened  Chat Assigned  Chat Closed 
Customer Data
Country
Custom info feed (value 1)
Custom info feed (value 2)
Custom info feed (value 3)
Customer language
Date of last visit, if any
Department ID
Host Name
IP Address
ISP Company Name
Keywords used if referrer is a search engine
Number of pages visited
Operator notes
Referrer URL
Visitor current page
Visitor entry page
Visitor ID
Visitor referral source

Browser Data
Browser Name
Browser platform
Browser Version
Java enabled
Screen resolution

Chat Data
Chat session unique ID
Chat window ID
Customer email
Pre-chat form values (Field 1)
Pre-chat form values (Field 2)
Pre-chat form values (Field 3)
Pre-chat form values (Field 4)
Customer first name
Customer last name
Customer full name

 

Customer Data
Country
Custom info feed (value 1)
Custom info feed (value 2)
Custom info feed (value 3)
Customer language
Date of last visit, if any
Department ID
Host Name
IP Address
ISP Company Name
Keywords used if referrer is a search engine
Number of pages visited
Operator notes
Referrer URL
Visitor current page
Visitor entry page
Visitor ID
Visitor referral source

Browser Data
Browser Name
Browser platform
Browser Version
Java enabled
Screen resolution

Chat Data
Chat session unique ID
Chat window ID
Chatting Operator Email
Chatting Operator ID
Chatting Operator Username
Custom ID
Customer email
HubSpot ID
Phone ID
Pre-chat form values (Field 1)
Pre-chat form values (Field 2)
Pre-chat form values (Field 3)
Pre-chat form values (Field 4)
SalesForce ID
Customer first name
Customer last name
Customer full name

 

Customer Data
Country
Custom info feed (value 1)
Custom info feed (value 2)
Custom info feed (value 3)
Customer language
Date of last visit, if any
Department ID
Host Name
IP Address
ISP Company Name
Keywords used if referrer is a search engine
Number of pages visited
Operator notes
Referrer URL
Visitor current page
Visitor entry page
Visitor ID
Visitor referral source

Browser Data
Browser Name
Browser platform
Browser Version
Java enabled
Screen resolution

Chat Data
Chat session unique ID
Chat transcript URL
Chat window ID
Chatting Operator Email
Chatting Operator ID
Chatting Operator Username
Custom ID
Custom Identifier 1
Custom Identifier 10
Custom Identifier 2
Custom Identifier 3
Custom Identifier 4
Custom Identifier 5
Custom Identifier 6
Custom Identifier 7
Custom Identifier 8
Custom Identifier 9
Customer chat transcript
Customer email
HubSpot ID
Phone ID
Pre-chat form values (Field 1)
Pre-chat form values (Field 2)
Pre-chat form values (Field 3)
Pre-chat form values (Field 4)
SalesForce ID
Customer first name
Customer last name
Customer full name
Chat start time
Chat end time

 
 
Should you have any questions or concerns please do NOT hesitate to chat with us or submit a ticket for support. We are here to help!
 

Leave a comment?

0 Comments
Login
REGISTER WITH EMAIL

Related articles

  • Why LiveHelpNow Help Desk Software is Different
    • 34874
    • 34
  • Banning IP Addresses
    • 29321
    • 60
  • Can I place chat buttons on more than one site/domain?
    • 26993
    • 59
  • Custom information feed
    • 35320
    • 29
  • Mobile Chat - Live Chat for Mobile
    • 30936
    • 31
  • Integration with other CRM systems
    • 23430
    • 57
  • Install live chat as a link
    • 33340
    • 62
    • 0
  • Custom Live Chat Buttons
    • 39526
    • 88
  • Trigger chat invitations
    • 31359
    • 61
  • Visitor Tracking
    • 22484
    • 58
  • Is there a way for LiveHelpNow to push customer data such as Name, Email, Chat transcript, Offline message, etc. to my contact management system automatically, in realtime?
Rate this article
Subscribe to alerts for this article below
Your email is now subscribed to alerts for this article
Your email is not subscribed to alerts for this article
Unsubscribe to alerts for this article below

Company Sites

Home

Blog

Test Agents

Hire Agents

GDPR Info

Privacy policy

Categories

  • General Questions
  • Getting Started
  • Customization
  • Advanced Customization
  • Troubleshooting
  • Security and Compliance
  • -- All Categories --

Connect With Us

  • LiveHelpNow
  • The most agent friendly contact center software
  • 515 S West End Blvd Suite 202
    Quakertown, PA 18951

  • 877-548-3001
  • help@livehelpnow.com
  • https://www.livehelpnow.net
    Powered by LiveHelpNow customer support suite