snippet.js
v1.0.9
Published
The JavaScript snippet for Chameleon
Downloads
22
Maintainers
Readme
Chameleon snippet.js
#Getting started
Use it
- Copy index.min.js
- Replace
{{ACCOUNT_TOKEN}}
with yours from the Chameleon dashboard. - Include it on all HTML pages (before the closing
</head>
tag) - Include it only in production (even if you have a staging and/or test instances).
- For all private pages, call
chmln.setup(userProperties)
- Deploy the app
chmln.setup
spec
The chmln.setup
call specifies a user identity that you reference across the user's lifetime. Every chmln.setup
call must have a user id (UID) and time that the user was created.
| Property | Description |
|---|---|
| uid - required | A unique identifier for the user in your database. |
| created - required | The date the user's account was first created. Any date format will work. |
| email - recommended | The email address of the user |
| plan - recommended | Which plan a user falls under (i.e gold
, startup
, enterprise
) |
| role - recommended | The specific type of tasks this user can perform (i.e. owner
, admin
, member
, billing
) |
| spend - recommended | The amount of monthly revenue generated by the user's account |
- Recommended properties are optional but are valuable.
Examples
Setup with email, plan and role properties:
chmln.setup({uid: user.id, created: user.createdAt, email: user.email, plan: 'gold', role: 'admin'});
Footnote: http://eschooltoday.com/ecosystems/scales-of-an-ecosystem.html Micro: A small scale ecosystem such as a pond, puddle, tree trunk, under a rock etc. Messo: A medium scale ecosystem such as a forest or a large lake.