Skip to content

Create Notification

POST
/notification/v1/playerid/{player_id}/notification

Create new notification for client. Requires permission to create for a different client

Required Permissions:

  • For any playerid (including themselves) any of: notification:playerid:write, notification:playerid:*

  • For the playerid themselves any of: notification:playerid:self:write, notification:playerid:self:*

Authorizations

Parameters

Path Parameters

player_id
required
integer

Request Body required

object
notifications
required

List of notifications creation requests

Array<object>
>= 1 items <= 100 items
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

Responses

200

Successful Response

object
notification_id
required

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

string

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_format - Invalid Authorization - {}
  • auth_token_unknown - Failed to parse token
  • insufficient_permissions - Insufficient Permissions
  • auth_token_sig_invalid - Token Signature is invalid
  • auth_invalid_key_id - Invalid Authorization - Invalid Key ID in Access Token
  • auth_invalid_version - Invalid Authorization - version
  • auth_token_invalid_claim - Token contained invalid claim value: {}
  • auth_not_jwt - Invalid Authorization
  • auth_malformed_access - Invalid Authorization - malformed access token
  • auth_token_expired - Token is expired
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