This preview of pull request 1639 is meant for internal use only.

LiveChat Destination

LiveChat quick info

LiveChat accepts Identify calls. If you reference it in the Integrations object, call it “LiveChat”.

LiveChat accepts device-mode data only from Analytics.js.

Getting Started

When you enable LiveChat in the Segment web app, your changes appear in the Segment CDN in about 45 minutes, and then Analytics.js starts asynchronously loading LiveChat’s javascript onto your page. This means you should remove LiveChat’s snippet from your page.

  • LiveChat’s chat box will appear on your page and you can start chatting with visitors.

LiveChat is only supported on the client-side.


Identify

When you call identify on analytics.js, we take all the traits you provide and set them as custom variables using LiveChat’s set_custom_variables function. We use the userId you provide to identify as a custom variable called User ID.

Record Live Chat Events

With this destination, you can automatically record track events for live chat conversations. If you select this option, we’ll collect the following events:

  • Live Chat Conversation Started
  • Live Chat Conversation Ended
  • Live Chat Message
  • Live Chat Message Received

These events will then flow out to your other tools, so you can do things like analyze if users who chat spend more money over time.

To learn more about the live chat events you can capture with this destination, head on over to our Live Chat spec docs.

Turn on LiveChat

Supported Sources and Connection Modes

Before you start, make sure LiveChat supports the source type and connection mode you’ve chosen to implement. You can learn more about connection modes here.

Web Mobile Server
📱 Device-mode ⬜️ ⬜️
☁️ Cloud-mode ⬜️ ⬜️ ⬜️

Settings

Segment lets you change these destination settings from the Segment app without having to touch any code.

Group

You can divide LiveChat agents into different groups such as “Billing” or “Support”

License

You can find your License key in your LiveChat Javascript snippet on the Settings > Installation page. Or, if you’re just signing up, it’s right in the setup guide!

Record live chat events.

Automatically send Live Chat message events, conversation starts and ends to other tools you have enabled.

This page was last modified: 20 Oct 2020



Get started with Segment

Segment is the easiest way to integrate your websites & mobile apps data to over 300 analytics and growth tools.
or
Create free account