Developer docs
Add web push to any website, send from your server with the REST API, and wire relaybell into your app with events, webhooks and the server SDKs.
For AI assistants:llms.txtllms-full.txtAll docs as Markdownopenapi.json
- Quickstart Add the snippet and the service worker, then send your first push.
- Send with the API POST /api/v1/notifications to everyone, a segment or one user.
- API reference Every endpoint with its scope, parameters, responses and errors.
- Browser SDK RelayBell.init() options and every method, from subscribeNow to track.
Get started
Add relaybell to a website and send your first notification.
Install
The service worker, frameworks, WordPress, Shopify and Google Tag Manager.
- Installing the SDKHosting the service worker (sw.js, swPath, swScope), apiBase, and the iPhone/iPad Home Screen rule.
- Next.jsAdd relaybell to a Next.js App Router site: load the SDK with next/script, call init() once, serve sw.js from public/ and link signed-in users.
- React (Vite or Create React App)Add relaybell to a single-page React app built with Vite or Create React App: the snippet in index.html, sw.js in public/, a subscribe button and signed-in users.
- Vue and NuxtAdd relaybell to a Vue 3 app (Vite) or a Nuxt 3 site: load the SDK once, serve sw.js from public/, add a subscribe button and link signed-in users.
- WordPress & WooCommerceThe WordPress & WooCommerce plugin: one-click connect, catalog sync for recommendations, reading activity, WooCommerce events, past-order import, back-in-stock button, identity verification.
- ShopifyThe relaybell Shopify app: install, turn on the app embed, add the Alert me button, what syncs on its own, shopper activity, signed-in customers, privacy and uninstall.
- Google Tag ManagerInstalling relaybell with Google Tag Manager: the relaybell tag template, or a Custom HTML tag.
- Google Analytics eventsUse the GA4 e-commerce events your site already pushes to the dataLayer: what is recorded, consent mode, orders counted once, privacy.
Browser SDK
RelayBell.init(), every SDK method and the opt-in prompt.
Sending
Send with the REST API: to everyone, a segment or one of your users.
- Sending notificationsPOST /api/v1/notifications: fields, targeting, scheduling, A/B tests, merge tags and cancelling a scheduled send.
- Send to one userTransactional sends to one of your own users by externalId, with examples in cURL, Node.js, Python and PHP.
- DraftsSave a notification as a draft with the API, change it as often as you like, then send it.
- Personalization & recommendationsInterest profiles, the catalog (products, articles, courses, listings; feeds, RSS and WordPress sync), {rec.*} recommendation tags, AI-written wording per interest, smart send time and how the data is kept.
- AI writingWrite it for me, Improve my text and AI wording per person: where the AI runs, what it sees, what it is never allowed to write, daily limits, and the /api/v1/ai routes.
- AutopilotPer-person message limits by engagement (the four tiers, daily and weekly limits, the time between messages, the comparison group, what is never limited) and playbooks: ready-made messages Autopilot sends for you.
Audience
Segments, topics, subscribers and data-protection requests.
Automation
Events, automations, product alerts and drip sequences.
- Events & automationPOST /api/v1/events, conversions and attribution, automations (conditions, delays, cancelOn) and auto-capture.
- Product alertsBack-in-stock and price-drop alerts: the "Notify me" button, interest events and the broadcast to everyone interested.
- Drip sequencesDrip sequences (journeys): subscribe and event triggers, message and branch steps, editing rules.
Developers
API keys, identity verification, reports, webhooks and the server SDKs.
- REST API authenticationBearer API keys, scopes and which routes need them, creating and revoking keys, expiry.
- Identity verificationIdentity verification: userHash = HMAC-SHA256 of the externalId with the website's secret key; /api/v1/identity.
- Analytics & reportsStats, daily numbers, the notification list and detail, delivery health and CSV export.
- WebhooksOutbound webhooks: events, signatures and how to verify them, retries, the delivery log, resend, test events and auto-disable.
- Website settings & more routesGET and PUT /api/v1/settings for a website, plus the other API routes.
- Catalog & order import APIPush products, articles, courses and listings to relaybell (POST /catalog/items), remove them, run a full sync, and import past orders and actions (POST /events/import).
- Server SDKsThe Node.js, Python and PHP server SDKs, including listing notifications and verifying webhooks.
- ZapierZapier actions and trigger (by invite).
- AI assistants (MCP)Connect Claude, Cursor, VS Code or Windsurf to relaybell with the relaybell-mcp server, so your assistant can read your results and send notifications after you confirm.
Reference
Every endpoint, error code and rate limit, browser support and what changed.
- API referenceEvery REST endpoint with its scope, parameters, request body, responses, error codes and code samples, generated from the OpenAPI document.
- Errors & rate limitsEvery error code with its HTTP status, plus the request and send rate limits.
- Account & supportDashboard-only account and support endpoints.
- Browser supportSupported browsers, and what iPhone/iPad need.
- ChangelogWhat changed for developers: the docs in the new site and relaybell for AI assistants; webhooks v2, server SDKs 1.2.0 and the OpenAPI reference; WordPress plugin 1.2.5.