Show a Product Demo via JS API

To learn more about the Chameleon Demos product, visit our product documentation.

Show the Demo (`chmln.show()`)

Call chmln.show with the Chameleon ID of the Demo (part of the Demo URL, or copyable from the dashboard slideout).

chmln.show('DEMO_ID', { kind: 'demo' });

The kind: 'demo' option is required to distinguish Demos from Tours, which also use chmln.show.

Finding the Demo ID

Open the Chameleon Dashboard.
Navigate to the Demo you want to trigger.
Copy the ID from the URL or use the “Copy ID” option in the dashboard slideout.

Options

Option	Default	Description
`kind`	-	Required. Must be `'demo'` to show a Demo.
`use_segmentation`	`false`	Whether to apply the Audience (Segmentation) before showing. If `true`, the Demo only shows if the user matches the configured Segment.
`once`	`false`	Whether to check if the user has already seen this Demo. If `true`, it will not show again for users who have already completed it.

Examples

Show a Demo immediately:

chmln.show('5f3c4232c712de665632a6d5', { kind: 'demo' });

Show only for users who haven’t seen it before:

chmln.show('5f3c4232c712de665632a6d5', {
  kind: 'demo',
  once: true,
});

When embedding Demos on your marketing website for anonymous visitors, you may need to handle consent. Use the data-consent-mode attribute on the Demo iframe element:

<iframe src="https://app.chameleon.io/demos/DEMO_ID"
  data-consent-mode="granted">
</iframe>

Setting consent_mode to "granted" enables features like Clearbit Reveal for identifying anonymous traffic. See the demo.reveal webhook for details. See also:

Show a Tour — trigger Tours via JavaScript
Start an Automation — trigger Automations via JavaScript
Demos REST API — manage Demos via REST API
Demo webhooks — receive Demo interaction events

Getting Started

JavaScript API

Guides

Webhooks

REST API

Show a Product Demo via JS API

Show the Demo (`chmln.show()`)

Finding the Demo ID

Options

Examples

​Show the Demo (chmln.show())

​Finding the Demo ID

​Options

​Examples

​Consent handling

Show the Demo (`chmln.show()`)

Finding the Demo ID

Options

Examples

Consent handling