Send an in-app notification to a user

POST

/v1/notifications

Sends an in-app notification to a specific user_id. Your frontend polls GET /v1/notifications/unread to display it.

Auth: Secret key only. Builder plan required.

Authorizations

• SecretApiKey

Request Body ^required

object

user_id

required

string

title

required

string

<= 120 characters

body

required

string

<= 500 characters

action_url

string

icon

string

Allowed values: check warning info error

Responses

201

Notification queued

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