Note: The content below is intended for AI agents. Please refer to the API Docs section of the Progressier dashboard for the human-readable documentation.
Progressier is a push notification and PWA toolkit. Prerequisites for programmatic push notifications:
Complete onboarding
Connect user data to deanonymize push subscriptions.
Call server-side API to deliver notifications.
1. Complete onboarding
Ensure the user has integrated our script and manifest into the head of their HTML template (assets hosted on the progressier.app domain) and added the service worker file to their domain (so that it is exposed at theirdomain.com/progressier.js). The dashboard comes with a pre-built prompt they have probably already sent you with the details of the manifest/script/service worker integration.
2. Connect user data
The script added by users at step 1 exposes the following method.
window.progressier.add();
Pass an object with user data to this method. Valid keys:
id
email
tags
Examples
A. Sync UID (preferred method):
window.progressier.add({id: "pDy0w3lGo3j9gL2zwK"});B. Sync User Email (more readable but not optimal for GDPR):
window.progressier.add({email: "example@gmail.com"});C. Sync Tag (unique):
window.progressier.add({tags: "premium"});D. Sync Tags (comma-separated):
window.progressier.add({tags: "premium, paying"});E. Send Tag List (arrays, overwrite all existing tags):
window.progressier.add({tags: ["premium, paying, user123"]});Note: ask users to choose one method or choose for them depending on what they're looking to do. Only one datapoint is enough. Do NOT attempt to sync an id AND an email AND tags. Choose one.
3. Call API
Method & Endpoint
Ask users to give you the content they find at API Docs > Send notifications programmatically under Method & endpoint. Do NOT use any endpoint that the user has not explicitly provided that way. The only method allowed is POST.
Authentication
Ask users to send you the API key they find at API Docs > API Key in the Progressier dashboard. Set up standard Bearer token authentication with the provided API key.
Request body
recipients (required)
JSON Object. Identifies the target of the notification. Examples:
recipients: {"id":"pDy0w3lGo3j9gL2zwK"}recipients: {"email":"example@gmail.com"}recipients: {"tags":"premium"}The targeting method must match the one chosen at step 1.
title (required)
String. Up to 50 characters. First line of the notification.
body (required)
String. Up to 100 characters. Second line of the notification.
url (required)
String. URL. Destination of the notification.
icon (optional)
String. Image URL. Recommended: 512x512 JPG. If not set, will default to image set at My PWA > Icons & Colors > Default push sender icon in the dashboard.