Intercom

Intercom button shown in the corner of a page

Overview

The Intercom module supports an Intercom chat widget on a page.col

Properties

Intercom App ID Alphanumeric String Stores your Intercom App ID for the widget to access your workspace.

Intercom API Url String, url Stores your Intercom API url for the widget to access your workspace. This should correspond with workspace region, and can be found in your under Settings > Installation > Web in the "With code" tab.

Intercom Launcher Alignment String - right or left Can be set as right or left of the bottom of the page.

Intercom Background Color String - Valid hex code (#FFFFF) Sets the background color behind your team profile and other attributes in the widget.

Intercom Action Color String - Valid hex code (#FFFFF) Used in button links and other elements to highlight and accent.

Nodes

Broadcasters

Intercom:on-hide Broadcasts a hide event on the Intercom widget

Intercom:on-show Broadcasts a show event on the Intercom widget

Intercom:on-unread-count-change Broadcast when the Intercom unread count changes, this could include changing the count to zero.

Listeners

Intercom:boot Used to ensure Intercom has been loaded.

Parameters

none

Intercom:hide Explicitly hide the Intercom messenger.

Parameters

none

Intercom:show Explicitly show the Intercom messenger.

Parameters

none

Intercom:showMessages Explicitly show the Intercom messenger with message list.

Parameters

none

Intercom:trackEvent Associate the event with the currently logged in user and send it to Intercom.

Parameters

name - Name of the tracking event associated with a user

Intercom:update Update the Intercom widget to register a URL or route change.

Parameters

none

Last updated

Was this helpful?