Concepts

Content types, drafts and versions, environments, approvals, audiences and keys.

Content types

Type	What it is
Tour	Ordered steps, each pointing at an element on the page (or centered), that walk someone through one workflow.
Tooltip	A hint attached to one element, behind a pulsing beacon, or opened on hover or click.
Banner	A notice across the top or bottom of the page. Its button only dismisses it.
Checklist	Onboarding tasks people tick off from a launcher. Items can start a tour or open a page, and can complete themselves.
Survey	Up to 12 questions (NPS, rating, single or multiple choice, text) in a modal or slide-out.
Announcement	Product news for the "What's new" feed, or shown as a banner or modal when it goes live, with an optional call to action.

Drafts, publishing and versions

Every item has a working draft. Saving changes only the draft; the people using your app don't see it.

Publishing saves the draft as a new numbered version and serves it in an environment. People keep seeing that version until you publish again, so you can keep editing a live item safely.

Unpublish stops showing an item. Its draft and history stay, and publishing brings it back.
Roll back by publishing an earlier version. The draft isn't touched.
Restore copies an earlier version into the draft, to continue from it.
Preview shows the draft on your real site, only to you, before it's published.

Environments

Content can be published to production and, when environments are on for your workspace, to staging. Each environment has its own publishable key: pk_… shows production, pk_test_… shows staging. Put the staging key in the snippet on your staging app. See Staging.

Approvals

A workspace can require review before anything goes to production. Then:

Someone with edit access sends a review request with a note.
Everyone who can publish gets an email, and the request shows in Approvals.
A publisher approves it (the requested version goes live) or rejects it with a note.

You can't approve your own request, unless you're the workspace's only publisher. Who can edit, publish and approve comes from roles and permissions.

URL patterns

Each item has a URL pattern: the pages it shows on. * is a wildcard.

Pattern	Matches
`https://app.example.com/*`	Every page on app.example.com
`https://app.example.com/dashboard`	Only the dashboard page
`https://app.example.com/users/*`	Every page under /users/

Trailing slashes are handled for you. Keep patterns as specific as the guidance: a tooltip for one button belongs on one page.

Audiences

Audience rules decide who sees an item on those pages. Match all or any of up to 20 rules:

Traits you pass to Cueston.identify(): role, permissions, plan, or any custom attribute.
Behaviour: performed an event at least (or fewer than) a number of times within some days, or never; completed, saw or dismissed another item; first or last seen more or less than some days ago.
Segments: saved audiences that any item can reuse. Items carry their segments' rules as they were when published: after changing a segment, publish the items that use it again (until then they show unpublished changes).

Visitors you don't identify only see content without targeting rules.

Frequency, schedules and limits

Frequency caps how often one person sees an item. "Once" means until they've seen, completed or dismissed it. Tooltips and banners can also show at most daily, weekly, or a custom number of times a set number of days apart. Tours can show always, on every visit, every Nth visit or every N days.
Schedule: start showing it at a set date and time.
Workspace limits (Settings → Workspace → Engagement) keep guidance from piling up: the most pop-ups per visit, the most per day, and minutes to wait between them. They apply to tours, surveys, auto-opening checklists and banners with a backdrop. Tooltips and beacons don't count.

Keys

Key	Where it lives	What it can do
`pk_…`	Your site's page source (the snippet)	Read published guidance and send analytics. Nothing else.
`pk_test_…`	Your staging app's snippet	The same, for content published to staging.
`sk_…`	Your server, scripts, CI, the Chrome extension	Acts as the person who created it, with their current role.