Skip to main content
This endpoint returns the state of one browser’s push subscription on your account. Call it when the page loads to find out if you must subscribe again.

Operation Type (for Signing)

Request Body

FieldTypeNeedDescriptionExample
”account”stringrequiredUser’s wallet address42trU9A5…
“signature”stringrequiredCryptographic signature5j1Vy9Uq…
“timestamp”integerrequiredCurrent timestamp in milliseconds1716200000000
”installation_id”stringrequiredThe browser’s installation ID from Register Web Push subscriptionk3Jx9_Qm…
“expiry_window”integeroptionalSignature expiry in milliseconds30000
”agent_wallet”stringoptionalAgent wallet address69trU9A5…
You can sign this request with the account key or with an agent wallet.

Response

  • Status 200: Successfully retrieved the subscription state
FieldTypeDescription
”subscription_id”UUID or nullSubscription ID. null when “state” is “not_registered"
"state”stringSubscription state (see below)
“vapid_public_key”string or nullVAPID public key that the subscription was registered with. null when “state” is “not_registered”
Subscription States
  • Status 400: Invalid request parameters or signature. A bad installation_id returns error_id invalid_notification_device_id
  • Status 403: The account doesn’t exist. An account exists after its first deposit
  • Status 409: Web Push isn’t available (web_push_disabled)
  • Status 429: Rate limit exceeded
  • Status 500: Internal server error

Code Example (Python)