Start an Automation via JS API

To learn more about the Chameleon Automations product, please read this article.

Start an Automation (`chmln.show()`)

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

chmln.show('AUTOMATION_ID', { kind: 'automation' });

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

Open the Chameleon Dashboard.
Navigate to the Automation you want to trigger.
Copy the ID from the URL (e.g., https://app.chameleon.io/automations/AUTOMATION_ID) or use the “Copy ID” option in the dashboard slideout.

You can pass additional options as the second argument:

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

Start an Automation immediately for the current user:

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

Start only if the user matches the configured Segment and hasn’t seen it before:

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