See our detailed installation docs:
Key data to pass in
Account
account
: this represents the customer or company. Passing in this data allows you to:
see performance grouped by the company in Bento
launch personalized guides for users at a particular company
To pass in account identifying information, you will want to send in unique ids that represent the company. In your codebase, that might be called accountId
, orgId
, companyId
, groupId
.
Along with that, please pass in a human readable name like AcmeCo
or PiedPiper
for each, so that Bento users can identify which company is which.
Common mistakes: this is not your domain or id. This is the id of your customers.
Account user
accountUser
: this represents an individual who is using your app, and might be engaging with a Bento guide. Passing in this data allows you to:
see performance by the user
get notifications about the user's progress
To pass in accountUser
identifying information, please send in a unique id that represents an individual user. You can also pass in that user's name which allows you to get notifications and track progress in a human-readable way.
Best practices for loading the Bento snippet
The Bento embeddable is compressed and cached for performance. The main thing you can do to ensure load performance is to load the snippet async so it's not blocking.
Staging vs. Production
We are commonly asked if we support multiple app tokens (prod and staging). You can use the same app token if needed in a Staging environment.
If you do this, we recommend appending the environment to the end of the account name (i.e. AcmeCo (Prod) vs. AcmeCo (Staging))
Other best practices for staging vs. production:
Pass in the environment attribute (staging / production) to Bento so you can launch guides to each environment as needed
If you have links in your guides that would change between staging and production you can pass in the base URL as a variable and use dynamic URLs
Next steps after installing
Make sure you have at least 1 guide template created
Launch that guide to an account/user in order to see Bento appear in your app.
Refer to the detailed documentation and reach out with any questions, we always appreciate feedback on the pain points.