User Attributes are the easiest way to give the Helply widget extra context about the current user - the kind of information that helps the agent speak more naturally and follow your Guidance.
What this is for
User Attributes are great for:
- First name / last name
- Locale / timezone
- Lightweight product context (plan, tier, seat count) as long as it’s not a sensitive information
- Any “help the agent respond better” signal that’s not sensitive
Where to use it
User attributes can be used in the Configure -> Guidance
How to set User Attributes
You must first create attributes in the contacts page (check How to use them section in Quickstart).
You must fill those attributes on your client side, after the Helply widget is loaded.
Note: If an attribute key is marked Secure in your schema, it will not be included via updateMetadata.
If you need to set Secure fields, you must identify the user and provide Secure Attributes from your backend (see Contacts](./contacts.md)).
Because User Attributes are set in the browser, don’t use them to make secure decisions (billing, permissions, refunds, etc.). If it needs to be correct, make it Secure and set it via identify (link to contacts).
window.addEventListener('helplyAgentLoaded', function () {
window.helplyAgentWidget?.updateMetadata({
first_name: 'Ada',
locale: 'en-US',
pricing_plan: 'pro',
seats: 3,
is_trial: true,
});
});