Push a notice to a person's browsers (or one subscription)

post/notify/push/send

Push a notice to a person's browsers (or one subscription): title, body, an address to open, a tag that replaces an earlier notice. A subscription the push service says has ended is marked and raised as campaigns.push.expired.

Before you call

Credential: Authorization: Bearer $KEY
Scope: campaigns:write
Mcp: rivier_notify_push_send
Graphql: Mutation.campaignsNotifyPushSend
Sdk: campaigns.notifyPush.send
Cli: campaigns notify push send
Events: campaigns.push.expired

Request bodyapplication/json, required

titlestringrequired
At most 200 characters.
bodystring
Default: . At most 1000 characters.
urlstring (uri)
At most 1000 characters.
iconstring (uri)
At most 1000 characters.
userRefstring
Your own id for the person; Rivier keeps it as given and never shows it to anyone else At most 200 characters.
subscriptionIdstring (uuid)
tagstring
A later notice with the same tag replaces this one on the device At most 64 characters.
dataobject
ttlSecondsinteger
Default: 86400. At least 0. At most 2419200.
urgencystring
One of: very-low, low, normal, high. Default: normal.
topicstring
A push waiting with the same topic is replaced at the push service Pattern: ^[A-Za-z0-9_-]{1,32}$.

Responses

200application/json
Success
400application/json
The request was malformed
- errorstringrequired
- messagestring
401application/json
No valid credential
- errorstringrequired
- messagestring
403application/json
The credential lacks the scope, origin or address
- errorstringrequired
- messagestring
429application/json
Over the key's rate limit; see Retry-After
- errorstringrequired
- messagestring

Example request

curl -X POST 'https://api.rivier.ai/notify/push/send' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "title": "string"
}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown