/v1/workspaces/{workspace_id}/channels/webpushAuthGet the web push public key
The VAPID public key browsers subscribe with (`applicationServerKey`), or `configured: false` before one is generated or imported.
Path parameters
workspace_id*string · uuidId of the workspace.
Response · 200 The web push channel.
configured*booleanWhether the workspace has an active VAPID key (web push can send).
public_key*stringThe public key for `applicationServerKey`; null until a key is generated or imported.
credential_id*string · uuidThe credential id of the active key.
origin*objectHow the active key was created (`generated` or `imported`).
fingerprint*stringFingerprint of the active private key.
created_at*string · date-timeWhen the active key was created.
Example
Request
GET https://api.notify.productcraft.co/v1/workspaces/{workspace_id}/channels/webpush
Authorization: Bearer YOUR_TOKENimport { Notify } from "@productcraft/notify";
// Reads PRODUCTCRAFT_API_KEY and PRODUCTCRAFT_WORKSPACE_ID from the environment;
// client routes take a recipient token: notify.client({ token })
const notify = new Notify();
const webPushChannel = await notify.channels.webpush.retrieve();notify.channels.webpush.retrieve(options?): Notify.WebPushChannel
Response
{
"configured": false,
"public_key": "string",
"credential_id": "00000000-0000-0000-0000-000000000000",
"origin": {},
"fingerprint": "string",
"created_at": "2026-01-01T00:00:00.000Z"
}