Skip to content
RallyHere Docs

Get Notifications Page

GET
/notification/v1/player/{player_uuid}/notification

Get recent notifications ordered from the newest to the oldest.

It is important to stress that this endpoint returns notifications in reverse order compared to the streaming API. The first notification returned from this will be the newest one we can find, and older ones will be further down the page (or on later pages).

This API is useful for displaying a list of the most recent notifications to the user, only requesting further pages when the user requests a bigger list.

Client are expected to poll this endpoint regularly.

This version can be used for any client provided its id (with proper permissions)

Required Permissions:

  • For any player (including themselves) any of: notification:player:*, notification:player:read

  • For the player themselves any of: notification:player:self:*, notification:player:self:read

Authorizations

Parameters

Path Parameters

player_uuid
required
string format: uuid

Query Parameters

page_size
integer
default: 10 >= 1 <= 100
start_at

Return results starting at this index (inclusive). If none provided then will start at the latest notification. You cannot depend on the format of this string, and it must be considered opaque

string

Return results starting at this index (inclusive). If none provided then will start at the latest notification. You cannot depend on the format of this string, and it must be considered opaque

exclude_before

All notifications including and before this (chronologically) provided id will be ignored when returning results. You cannot depend on the format of this string, and it must be considered opaque

string

All notifications including and before this (chronologically) provided id will be ignored when returning results. You cannot depend on the format of this string, and it must be considered opaque

Header Parameters

if-none-match

If you provide the ETag that matches the current ETag for this content, will return a 304 response - indicating that the content has not changed

string

If you provide the ETag that matches the current ETag for this content, will return a 304 response - indicating that the content has not changed

Responses

200

Successful Response

object
notifications

List of notifications

Array<object>
default:
object
message
required

Base Message for the notification

string
<= 4096 characters
rh_url

Path to get additional data about this notification

string
>= 1 characters <= 4096 characters
custom_data

Custom values for the notification

object
key
additional properties
string
>= 1 characters <= 4096 characters
etag

ETag for the resource at rh_url at the time of this notification

string
>= 1 characters
notification_id
required

Unique Identifier for the notification. You cannot depend on the format of this string, and it must be considered opaque

string
created
required

When this notification was added

string format: date-time
cursor
required

Cursor to use for the next request

string

304

Not Modified

400

Error Codes:

  • bad_id - Passed client id is not a valid id
object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

403

Error Codes:

  • auth_token_invalid_type - Invalid Authorization - Invalid Token Type
  • auth_token_expired - Token is expired
  • auth_invalid_version - Invalid Authorization - version
  • auth_malformed_access - Invalid Authorization - malformed access token
  • auth_token_format - Invalid Authorization - {}
  • insufficient_permissions - Insufficient Permissions
  • auth_not_jwt - Invalid Authorization
  • auth_token_invalid_claim - Token contained invalid claim value: {}
  • auth_token_unknown - Failed to parse token
  • auth_token_sig_invalid - Token Signature is invalid
  • auth_invalid_key_id - Invalid Authorization - Invalid Key ID in Access Token
object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

409

Error Codes:

  • too_many_listening_to_single_client - An enumeration.
object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string

503

Error Codes:

  • connection_limit_reached - An enumeration.
object
auth_success
boolean
default: true
error_code
required
string
desc
required
string