Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.schedkit.net/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

SchedKit uses Web Push (VAPID) to deliver notifications to subscribed browsers. Notifications fire automatically on alert signals, urgent/high incidents, and upcoming assignments.

​
Endpoints

MethodPathDescription
GET/v1/push/vapid-publicGet VAPID public key
POST/v1/push/subscribeRegister a push subscription
DELETE/v1/push/subscribeRemove a push subscription
POST/v1/push/testSend a test notification

​
GET /v1/push/vapid-public

Returns the VAPID public key needed to subscribe a browser. 
{ "publicKey": "BIa_HKGuR_doeyRc..." }

​
POST /v1/push/subscribe

Register a browser’s push subscription with SchedKit. 
const reg = await navigator.serviceWorker.ready;
const sub = await reg.pushManager.subscribe({
  userVisibleOnly: true,
  applicationServerKey: vapidPublicKey
});

await fetch('/v1/push/subscribe', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({ subscription: sub.toJSON() })
});

​
DELETE /v1/push/subscribe

Unsubscribe the current device. Pass the endpoint to identify the subscription: 
{ "endpoint": "https://fcm.googleapis.com/fcm/send/..." }

​
POST /v1/push/test

Send a test push notification to all subscriptions for the current user. Useful for verifying the subscription is active. 
{}

​
Automatic push events

TriggerNotification
alert signal[~] ALERT SIGNAL — {operator}: {note}
urgent or high incident created[!] URGENT — {title}
alert-source incident[!] {title}
Upcoming assignment[◷] Upcoming: {event} in 15 min