Documentation

Getting started

Create a workspace, install your site, and send a test Nudge to a device you control.

What is a Nudge

A Nudge is a permission-based message you send only when it is worth sending.

Install your site

Connect a site with the JavaScript snippet, WordPress, or Google Tag Manager.

Opt-in and permission

Ask for notification permission in a way that matches your consent flow.

Send a Nudge

Compose, test, schedule, or send live. Stop a run if you need to.

Audience

See who subscribed, who is active, and how interests and rest states show up.

Fatigue and attention

Rest people who have been nudged too often. Skipping can be the right decision.

Analytics

Read delivery and outcomes from what the dashboard actually shows. Do not treat CTR as proof.

Billing and plans

Plans are priced on people in your audience. Sends are unlimited for normal use.

Privacy and ownership

Accept the DPA, export your data, delete a tenant, and keep your own VAPID keys.

JavaScript SDK

Load the snippet, pass site key and VAPID, and optionally send behavior events.

Service worker

Serve the /en-sw.js stub at a root-covering scope, or merge one import line into an existing worker.

Content-Security-Policy

Copy-paste CSP directives so the SDK, worker, and API calls are allowed.

REST API

Create and send campaigns with a tenant API key. Bearer tokens only. No dashboard cookies.

RSS and Atom feeds

Connect a feed. In tagged-only auto mode, only items marked as Nudge candidates send automatically.

WordPress plugin

Pair one WordPress site, inject the SDK, and create draft campaigns on publish.

Google Tag Manager

Import the SDK template. You still host /en-sw.js on the origin.

Next.js, Vue, and other SPAs

Same SDK and service worker. Only the paste location changes.

Shopify

The app is not released yet. Install the snippet in your theme instead.

Webhooks

Intended inbound payload for CMS publish events. Live HMAC ingest is not a public contract yet.

Behavior events

POST /v1/behavior-events and SDK track(). Commerce automations stay off until you enable them.

Troubleshooting install

HTTPS only, origin allowlist, service worker scope, and Install Doctor codes.