Skip to content

API reference

Push notifications

Push notifications per device (a browser or the installed app): availability, turning a device on or off, your devices and preferences, a test. Turned on in the app; machines are refused.

6 actions · base URL https://api.bizisy.com/v1 · generated from the same definitions as the API.

Push notifications: availability#

POST/v1/platform/push.configRead

Whether this server sends push notifications (the operator configured them) and the public key a browser subscribes with. Everyone.

Who can call it
Manage key any Manage role
Me key anyone
MCP tool
platform_push_config on My Workplace, HR Assistant
Method
POST with a JSON body, or GET with the input as query parameters

Input

No input: send {}.

Returns

  • availablebooleanrequired
  • public_keystring | nullrequired

Errors

validation_failed unauthenticated forbidden not_found rate_limited internal

curl
curl https://api.bizisy.com/v1/platform/push.config \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Response
{
  "data": {
    "available": true,
    "public_key": "BNc"
  }
}

Turn on push notifications on this device#

POST/v1/platform/push.subscribeWrite

Registers this browser or installed app for push notifications (the browser's subscription: endpoint on a known push service, its keys, and a label like "Chrome on Android"). At most 10 devices per login (the oldest goes). The payloads carry no names: the app shows the details. In the app only.

Web app only
Refused for API keys and connected apps. Push notifications are turned on in a browser or the installed app.
MCP tool
platform_push_subscribe on My Workplace, HR Assistant
Preview
?dry_run=true runs every check and saves nothing
Retries
An Idempotency-Key prevents a second run, but the result is never stored (it holds a secret or personal data): a retry gets a 409 that points to Activity

Input

  • endpointURLrequired

    Up to 1024 characters.

  • keysobjectrequired
    2 fields
    • p256dhstringrequired

      Up to 200 characters.

    • authstringrequired

      Up to 64 characters.

  • labelstringrequired

    1–60 characters.

Returns

  • deviceobjectrequired
    5 fields
    • idstringrequired
    • labelstringrequired
    • created_atstringrequired
    • last_sent_atstring | nullrequired
    • this_devicebooleanrequired

Errors

validation_failed unauthenticated forbidden not_found conflict rate_limited internal

curl
curl https://api.bizisy.com/v1/platform/push.subscribe \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "endpoint": "https://fcm.googleapis.com/fcm/send/abc",
  "keys": {
    "p256dh": "BOr7",
    "auth": "aGk"
  },
  "label": "Chrome on Android"
}'
Response
{
  "data": {
    "device": {
      "id": "d1",
      "label": "Chrome on Android",
      "created_at": "2026-10-12T09:00:00.000Z",
      "last_sent_at": null,
      "this_device": true
    }
  }
}

Turn off push notifications on a device#

POST/v1/platform/push.unsubscribeWrite

Removes one of your devices (by id from platform_push_devices, or this browser's endpoint). Nothing more is sent to it.

Who can call it
Manage key any Manage role
Me key anyone
MCP tool
platform_push_unsubscribe on My Workplace, HR Assistant
Preview
?dry_run=true runs every check and saves nothing
Retries
An Idempotency-Key prevents a second run, but the result is never stored (it holds a secret or personal data): a retry gets a 409 that points to Activity

Input

  • device_idstring

    1–60 characters.

  • endpointstring

    Up to 1024 characters.

Returns

  • removedintegerrequired

Errors

validation_failed unauthenticated forbidden not_found conflict rate_limited internal

curl
curl https://api.bizisy.com/v1/platform/push.unsubscribe \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"endpoint":"https://fcm.googleapis.com/fcm/send/abc"}'
Response
{
  "data": {
    "removed": 1
  }
}

My push devices#

POST/v1/platform/push.devicesRead

Your devices with push notifications on (label, since when, last sent; endpoint = this browser's marks it) and your preferences per kind. Never the endpoints.

Who can call it
Manage key any Manage role
Me key anyone
MCP tool
platform_push_devices on My Workplace, HR Assistant
Method
POST with a JSON body, or GET with the input as query parameters

Input

  • endpointstring

    Up to 1024 characters.

Returns

  • itemsobject[]required
    5 fields
    • idstringrequired
    • labelstringrequired
    • created_atstringrequired
    • last_sent_atstring | nullrequired
    • this_devicebooleanrequired
  • prefsobjectrequired
    5 fields
    • approvalsbooleanrequired

      Requests waiting for your decision and decisions on yours (changes, time off, time corrections).

    • clockbooleanrequired

      Time clock: still clocked in after your day, your month to acknowledge.

    • documentsbooleanrequired

      Documents shared with you (and, for HR, documents people added).

    • remindersbooleanrequired

      Daily reminders and checklist tasks.

    • announcementsbooleanrequired

      Announcements published to you.

Errors

validation_failed unauthenticated forbidden not_found rate_limited internal

curl
curl https://api.bizisy.com/v1/platform/push.devices \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"endpoint":"https://fcm.googleapis.com/fcm/send/abc"}'
Response
{
  "data": {
    "items": [
      {
        "id": "d1",
        "label": "Chrome on Android",
        "created_at": "2026-10-12T09:00:00.000Z",
        "last_sent_at": null,
        "this_device": true
      }
    ],
    "prefs": {
      "approvals": true,
      "clock": true,
      "documents": true,
      "reminders": false,
      "announcements": true
    }
  }
}

Push notification preferences#

POST/v1/platform/push.prefsWrite

Which kinds of notices you get as push on your devices: approvals, clock, documents, reminders, announcements (all on by default once a device is on). They stay in the app either way.

Who can call it
Manage key any Manage role
Me key anyone
MCP tool
platform_push_prefs on My Workplace, HR Assistant
Preview
?dry_run=true runs every check and saves nothing
Retries
An Idempotency-Key replays the first result

Input

  • approvalsboolean

    Requests waiting for your decision and decisions on yours (changes, time off, time corrections).

  • clockboolean

    Time clock: still clocked in after your day, your month to acknowledge.

  • documentsboolean

    Documents shared with you (and, for HR, documents people added).

  • remindersboolean

    Daily reminders and checklist tasks.

  • announcementsboolean

    Announcements published to you.

Returns

  • approvalsbooleanrequired

    Requests waiting for your decision and decisions on yours (changes, time off, time corrections).

  • clockbooleanrequired

    Time clock: still clocked in after your day, your month to acknowledge.

  • documentsbooleanrequired

    Documents shared with you (and, for HR, documents people added).

  • remindersbooleanrequired

    Daily reminders and checklist tasks.

  • announcementsbooleanrequired

    Announcements published to you.

Errors

validation_failed unauthenticated forbidden not_found conflict rate_limited internal

curl
curl https://api.bizisy.com/v1/platform/push.prefs \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "approvals": true,
  "clock": true,
  "documents": false,
  "reminders": false,
  "announcements": true
}'
Response
{
  "data": {
    "approvals": true,
    "clock": true,
    "documents": false,
    "reminders": false,
    "announcements": true
  }
}

Send a test push#

POST/v1/platform/push.testWrite

Sends a test notification to your devices within a minute (at most 5 an hour).

Who can call it
Manage key any Manage role
Me key anyone
MCP tool
platform_push_test on My Workplace, HR Assistant
Preview
?dry_run=true runs every check and saves nothing
Retries
An Idempotency-Key replays the first result

Input

  • device_idstring

    Up to 60 characters.

Returns

  • queuedintegerrequired

Errors

validation_failed unauthenticated forbidden not_found conflict rate_limited internal

curl
curl https://api.bizisy.com/v1/platform/push.test \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'
Response
{
  "data": {
    "queued": 1
  }
}

Something missing or wrong on this page? Write to hello@bizisy.com.

Developer docs