The bell: the number on it

GET

/v1/notifications/unread/count

This user’s unread notifications (direct, groups, and the broadcasts of the last 30 days), archived ones left out.

Auth: Publishable key from the browser, with user_id and user_hash = HMAC-SHA256(signing secret, user_id) as lowercase hex, in the X-Nordva-User-Hash header or a user_hash parameter. A secret key may name any user_id and needs no hash. A wrong or missing hash answers USER_HASH_INVALID (403).

Rate limits: a browser call counts against 120 requests a minute per IP address (not the key’s budget), and the bell reads (/inbox, /unread, /unread/count) share a per-user hourly budget: Free 180, Indie 540, Builder 720 (RATE_LIMITED, 429, with Retry-After).

CORS: Access-Control-Allow-Origin: *.

Authorizations

• PublishableApiKey
• SecretApiKey

Parameters

Query Parameters

user_id

required

string

<= 256 characters

user_hash

string

The same hash, when a header is inconvenient.

Header Parameters

X-Nordva-User-Hash

string

HMAC-SHA256(signing secret, user_id), lowercase hex.

Responses

200

Count

object

data

object

unread_count

integer

poll_interval_seconds

integer

error

null

meta

object

400

Error envelope. See error.code for the discriminator.

object

data

required

null

error

required

object

code

required

string

message

required

string

remediation

required

string

doc_url

string format: uri

param

string

request_id

string

meta

object

key

additional properties

401

Error envelope. See error.code for the discriminator.

object

data

required

null

error

required

object

code

required

string

message

required

string

remediation

required

string

doc_url

string format: uri

param

string

request_id

string

meta

object

key

additional properties

403

Error envelope. See error.code for the discriminator.

object

data

required

null

error

required

object

code

required

string

message

required

string

remediation

required

string

doc_url

string format: uri

param

string

request_id

string

meta

object

key

additional properties

429

Error envelope. See error.code for the discriminator.

object

data

required

null

error

required

object

code

required

string

message

required

string

remediation

required

string

doc_url

string format: uri

param

string

request_id

string

meta

object

key

additional properties