Four areas you control
All configuration happens in your Usivity dashboard. Once the script tag is in place, none of it needs a code deploy.
Zones
Which parts of your product Usivity can work in. Each zone is a named CSS selector.
Data sources
The external APIs Usivity may call. Nothing connects without your explicit approval.
Branding
How Usivity looks inside your product: colors, title, welcome text, and whether the welcome screen shows.
Security
Which domains can load your SDK, plus your HMAC secret and API key.
Zones
Zones define where Usivity runs. A zone is a named CSS selector for one part of your product. Usivity works only inside your zones; everything outside them is untouched.
Create as many zones as you need, across as many pages as you like. Add, rename or remove them from the dashboard at any time, with no code change.
| Field | What it does |
|---|---|
| Name | A readable label, shown in your dashboard and in the SDK’s zone list. |
| CSS selector | The selector (or HTML element ID) for the part of the page where Usivity works. Usivity runs only inside these selectors. |
| Description | Optional notes for your team. Dashboard-only; never shown to end users. |
Data sources
Register the APIs Usivity is allowed to call. If you want Usivity to pull in external data (a CRM field, a metric, a lookup), you add that endpoint in your dashboard. Usivity calls nothing that is not on your list.
Create entries by importing API documentation, or add them by hand. Each source can be switched on or off without deleting it.
| Field | What it does |
|---|---|
| URL | The endpoint Usivity calls. |
| Method | GET only. Data sources are read-only, and the server enforces it. |
| Auth type | The user’s own browser session (their existing sign-in to your app), or none. Usivity stores no credentials for your APIs. |
| Headers | Any fixed request headers the endpoint requires. |
| Query parameters | Static query parameters added to every request. |
| Response mapping | How Usivity reads the response and maps its fields for use in personalizations. |
| Active flag | Turn a data source on or off without deleting it. Inactive sources are not available to the SDK. |
Branding
Control how Usivity presents itself inside your product. These settings apply across all zones.
| Setting | What it does |
|---|---|
| SDK title | The name shown in the Usivity panel inside your product. |
| Theme | The panel’s look in one go: Usivity, Classic, Neutral, or Custom for your own primary and accent colors. |
| Primary color | The main accent color in Usivity’s interface. |
| Accent color | A second color for highlights and interactive states. |
| Welcome heading | The heading on the Usivity welcome screen. |
| Welcome body | The text beneath the welcome heading. |
| Hero enabled | Turns the welcome screen on or off. When off, users go straight to the personalization panel. |
Security
Control which domains can load your SDK, and manage your credentials. Requests from unlisted origins are rejected at the server.
| Setting | What it does |
|---|---|
| Domain allowlist | The domains (wildcard patterns included) allowed to load your SDK. Requests from any unlisted origin are rejected. Add, activate or deactivate entries at any time. |
| HMAC SSO secret | Verifies each end user’s identity when you pass their user ID, email and a hash in the embed. You can view and rotate it from your dashboard. |
| API key | Your SDK’s credential, required in the embed. You can regenerate it if it is ever compromised. |
What you pass at load time
These attributes go on the script tag in your product. They tell Usivity who is loading the SDK and which account they belong to.
The API key and the signed identity (user ID, email and hash) are required. Company and role are optional strings: Usivity stores them against the user record but does not yet change its behavior based on them. Server signing examples are on Security and architecture.
data-api-keyRequired- Your vendor API key. Tells the SDK which Usivity account to load configuration for.
data-user-idRequired- The user’s unique ID in your system. Signed together with the user’s email for HMAC identity verification, and used for visitor tracking and Access Control.
data-user-emailRequired- The user’s email. Signed together with the user ID; Usivity uses it to find or create the user’s account.
data-user-hashRequired- HMAC-SHA256 signature of the user ID, email and time payload, generated on your server with your HMAC secret. The SDK does not load without a valid signature.
data-user-tsRequired- When your server signed, in Unix seconds. Part of the signature, which starts a session for 24 hours after it was made, so a copied one stops working.
data-user-companyOptional- A free-form string for the customer account this user belongs to. Stored against the user record. Usivity enforces nothing based on it; it is there for your own filtering and reporting.
data-user-roleOptional- A free-form string for the user’s role. Stored against the user record. Usivity doesn’t gate features by this value. To control who gets Usivity, use the portal’s Access page.
Not available today
Evaluators often ask about these. They are on the roadmap but not shipped. If one matters to your evaluation, tell us in the demo form below: for the right fit, we can look at bringing it forward.
Gating by role or plan
Usivity doesn’t yet change what a user can personalize based on the role, plan or tier you pass. Who gets Usivity, whether they see the button, and whether they can make their own changes are set per user in the portal’s Access page.
Per-account feature gating
You cannot yet pass account tier, license level or plan through the SDK and have Usivity respond differently. Every account using your API key gets the same configuration.
Account-wide defaults
There is no setting that every user in an account inherits automatically. Your team can send the same change to all of an account’s users at once instead.