Docs
Esc

Suggested

QuickstartGet started
Webhooks and signaturesMessaging
Create a messagemessages.create · POST /v1/accounts/{AC}/messages
RATE_LIMITED429 · Rate limit exceeded.
message.deliveredMessage resource
Contents

API reference

Push notifications

API reference descriptions are provided in English to preserve the exact published contract.

List the signed-in user's registered browsers in this account and environment

GET/v1/accounts/{AC}/push/subscriptions

push.subscriptions.listSDK operation getV1AccountsByAcPushSubscriptions

Parameters

  • limitinteger (1–100)query
  • cursorstring (max 2048 chars)query

Register this browser for push notifications

POST/v1/accounts/{AC}/push/subscriptions

push.subscriptions.createSDK operation postV1AccountsByAcPushSubscriptions

Request body

  • endpointstring (max 2048 chars)Required
  • keysobjectRequired
    Show 2 child attributes
    • authstring (max 64 chars)Required
    • p256dhstring (max 200 chars)Required
  • userAgentstring (max 512 chars)

Withdraw this browser's push subscription

DELETE/v1/accounts/{AC}/push/subscriptions

push.subscriptions.deleteSDK operation deleteV1AccountsByAcPushSubscriptions

Request body

  • endpointstring (max 2048 chars)Required

The public key a browser subscribes with

GET/v1/accounts/{AC}/push/vapid

push.vapid.listSDK operation getV1AccountsByAcPushVapid