REST API

Progressify registers its endpoints under the progressify/v1 namespace. They exist to serve the plugin’s own admin screen and front-end scripts, so treat them as an internal API: they are documented here for debugging and integration, but they are not a versioned public contract and may change between releases.

https://example.com/wp-json/progressify/v1/

Authentication

Administrative endpoints require the manage_options capability and a valid X-WP-Nonce header. Public endpoints exist because visitors who are not logged in have to be able to subscribe to notifications and be counted in analytics.

Do not request a nonce from /nonce while logged in and reuse it for an administrative call. A nonce minted for an anonymous request belongs to user 0 and will be rejected. That endpoint exists to give front-end scripts a fresh nonce on cached pages.

Endpoints

Endpoint	Method	Access
`/settings`	PUT	`manage_options`
`/nonce`	GET	Public
`/pwa-score/fetch`	GET	`manage_options`
`/pwa-users/upsert`	PUT	Public
`/pwa-users/fetch`	GET	`manage_options`
`/pwa-assets/check`	POST	`manage_options`
`/pwa-assets/save`	POST	`manage_options`
`/service-worker/generate`	POST	`manage_options`
`/push-subscription/add`	POST	Public
`/push-subscription/update`	PUT	Public
`/push-subscription/sync`	POST	Public
`/push-subscription/remove`	DELETE	Public
`/push-subscribers/fetch`	GET	`manage_options`
`/push-subscribers/send`	POST	`manage_options`

Settings

Update settings

endpoint

Merges the supplied values over the stored settings. Only send the keys you want to change; anything you omit keeps its current value.

curl -X PUT https://example.com/wp-json/progressify/v1/settings \
  -H "X-WP-Nonce: $NONCE" \
  -H "Content-Type: application/json" \
  --cookie "$COOKIE_JAR" \
  -d '{"settings": {"offlineCacheStrategy": "StaleWhileRevalidate"}}'

Fires progressify_settings_update:before and :after around the write.

There is no GET counterpart. Read settings in PHP with get_option('progressify_settings').

Metrics

Fetch the PWA score

endpoint

Returns the score shown on the overview page.

{
  "status": "success",
  "data": {
    "scoreResult": "Good",
    "scorePercent": 75,
    "actionItems": []
  }
}

scoreResult is Excellent at 100, Good from 50, Average from 25, and Bad below that. actionItems lists what is still missing and is only present with an active Pro license.

PWA users

endpoint

Public. Records or updates the current visitor as a PWA user. Called automatically by the front-end script.

endpoint

Returns the install and usage analytics behind the overview page.

Generated files

Generate the service worker

endpoint

Rebuilds /wp-content/uploads/progressify/scripts/serviceworker.js from the current settings. Use this after changing the progressify_serviceworker filter, or when the scorecard reports the file is missing.

PWA assets

endpoint

Reports whether the icon set and splash screens exist.

endpoint

Regenerates them from the configured app icon and background color.

Push notifications

Subscriptions

The four subscription endpoints are public because they are called by visitors’ browsers.

endpoint

Stores a new Web Push subscription. Sends the welcome notification if that automation is enabled.

endpoint

Updates an existing subscription, which browsers rotate periodically.

endpoint

Re-binds an existing subscription to the currently logged-in user.

endpoint

Deletes a subscription. Used when a visitor unsubscribes and when an admin removes a subscriber.

Fetch subscribers

endpoint

Returns the paginated subscriber list shown on the overview page, with country, operating system, browser, and subscription date.

Send a notification

endpoint

Sends a notification to every subscriber. Takes a single notificationData object.

Show notificationData fields

string

The notification title.

string

The body text.

integer

Attachment ID of a large image to display.

string

Where the notification opens when selected.

string

on keeps the notification on screen until the visitor dismisses it.

string

on vibrates the device on arrival.

array

Pro. Up to two objects of { text, url }, rendered as buttons on the notification.

curl -X POST https://example.com/wp-json/progressify/v1/push-subscribers/send \
  -H "X-WP-Nonce: $NONCE" \
  -H "Content-Type: application/json" \
  --cookie "$COOKIE_JAR" \
  -d '{
        "notificationData": {
          "notificationTitle": "Spring sale is live",
          "notificationMessage": "20% off everything until Sunday.",
          "notificationUrl": "https://example.com/sale/"
        }
      }'

Delivery is chunked according to the Batch Size setting, and the response reports how many messages were sent and how many failed.

Getting started

Settings

Guides

Developer reference

Support

Authentication

Endpoints

Settings

Update settings

Metrics

Fetch the PWA score

PWA users

Generated files

Generate the service worker

PWA assets

Push notifications

Subscriptions

Fetch subscribers

Send a notification

​Authentication

​Endpoints

​Settings

​Update settings

​Metrics

​Fetch the PWA score

​PWA users

​Generated files

​Generate the service worker

​PWA assets

​Push notifications

​Subscriptions

​Fetch subscribers

​Send a notification

Authentication

Endpoints

Settings

Update settings

Metrics

Fetch the PWA score

PWA users

Generated files

Generate the service worker

PWA assets

Push notifications

Subscriptions

Fetch subscribers

Send a notification