For Chameleon to show product guidance to your users, the Chameleon code needs to be added to your application's codebase.
Chameleon works with browser-based web products and supports a range of technologies. Read about what is supported here.
Once you have joined a paid plan and are ready to install the Chameleon code snippet (to allow you to publish tours live) you have 3 implementation options:
- Use our Segment integration. If you use Segment then this is by far the best way to add Chameleon. Learn more about this method here.
- Use Google Tag Manager (GTM). While we support this method, we advise against it, because of the difficulty of sending user data required for targeting. Learn more about this method here.
If you use Segment then you will not need any engineering time to install Chameleon!
Once you turn on the Chameleon-Segment integration (do so from here) the Chameleon code snippet will be added to your site via the Segment code. Chameleon will receive all the user data collected by Segment and Segment will receive all the user data collected by Chameleon, to further send to your other Segment-enabled integrations.
If you do not use Segment, then you will require engineering time to ensure Chameleon is installed correctly, so read on below.
Pre-requisites for installing Directly or using GTM
Before you proceed with installing Chameleon, knowing the following will help speed up the process and require the minimal engineering time:
- What is the process, timeline and people required to add third-party code to your application (via the Direct or GTM methods)?
- What user properties and event data will be useful to target your guidance? By knowing how you might want to segment users or the conditions upon which you want to show guidance, you can ensure this data is sent to Chameleon at the time of installation. Learn more about how this works here.
- Does your application have URLs that contain dynamic content, such as user IDs or customer subdomains? If so, it will be helpful to send this content to Chameleon for each user. Learn more about how this works here.
- Would you like to personalize your guidance with any dynamic content? For example, would you like to refer to users by their first names in the tours you create? If so, add this to the list of user data that your engineers will send to Chameleon. Learn more about how this works here.
- Does your application contain a Content Security Policy (CSP)? CSPs are a way to prevent unauthorized third-party code from running in your application, and will prevent Chameleon functioning. If you do have a CSP then your engineers will have to add Chameleon to the whitelist. Read about how to do that here.
- Does your application use keyboard shortcuts? If so, these may conflict with Chameleon and hinder your ability to type within the Chameleon Editor. To circumvent this issue, you engineers will need to add some extra code. Read about how to do that here.
If you are ready to install Chameleon, then please refer to our Installation articles: