Organization API: Org Staff Push

Base URL: https://api.coritan.com/api/v1. Paths below are complete.

To try these requests in the browser, open the interactive Organization API reference.

GET /api/v1/orgs/{org_slug}/staff/push/config

What a browser needs to ask for notifications: whether this brand can send them, and the public key the browser subscribes with. supported is false when the brand's console has no notification service worker, and then public_key is null.

GET /api/v1/orgs/{org_slug}/staff/push/preferences

Which kinds of event the calling member is told of: kind, label, enabled, allowed and reason. A kind the member's role cannot read has allowed false, enabled false and, in reason, the role it needs, such as "Needs Tier 3 support or higher". A kind the member never chose is on or off as its default says.

PUT /api/v1/orgs/{org_slug}/staff/push/preferences

Turn kinds of event on or off for the calling member, and answer with the same list as the read. An unknown kind answers 422 naming the kinds there are. Turning on a kind the member's role cannot read answers 403 with the role it needs; turning one off is always allowed.

application/json (required)

GET /api/v1/orgs/{org_slug}/staff/push/subscriptions

The calling member's own devices, oldest first: id, label (such as "Safari on iPhone"), created_at and last_sent_at.

POST /api/v1/orgs/{org_slug}/staff/push/subscriptions

Save the calling member's browser for notifications. The address must be a browser's own push service over https; anything else answers 422. Sending the same browser again updates its keys and answers 200 with the same device, and a member keeps at most 10 devices, the oldest dropping first.

application/json (required)

DELETE /api/v1/orgs/{org_slug}/staff/push/subscriptions/{subscription_id}

Stop sending notifications to one of the calling member's devices. Another member's device answers 404.

POST /api/v1/orgs/{org_slug}/staff/push/test

Send "Test notification" to every device of the calling member, whatever their kinds say. Answers devices (how many the member has) and sent (how many a push service accepted). Answers 409 when the member has no device, and 429 after 10 tests in an hour.