Create Notification

POST 
/notification/v1/player/:player_uuid/notification

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

Required Permissions:

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

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

Request

Path Parameters

player_uuid uuidrequired

application/json

Body

required

notifications

object[]

required

Possible values: >= 1, <= 100

List of notifications creation requests

Array [

message Message (string)required

Possible values: <= 4096 characters

Base Message for the notification

rh_url Rh Url (string)

Possible values: non-empty and <= 4096 characters

Path to get additional data about this notification

custom_data

object

Custom values for the notification

property name* string

etag Etag (string)

Possible values: non-empty

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

]

Responses

200

Successful Response

application/json

Schema

Schema

notification_id Notification Id (string)required

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

Example (from schema)

{
  "notification_id": "string"
}

400

Error Codes:

• bad_id - Passed client id is not a valid id

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

403

Error Codes:

• auth_invalid_key_id - Invalid Authorization - Invalid Key ID in Access Token

• auth_invalid_version - Invalid Authorization - version

• auth_malformed_access - Invalid Authorization - malformed access token

• auth_not_jwt - Invalid Authorization

• auth_token_expired - Token is expired

• auth_token_format - Invalid Authorization - {}

• auth_token_invalid_claim - Token contained invalid claim value: {}

• auth_token_invalid_type - Invalid Authorization - Invalid Token Type

• auth_token_sig_invalid - Token Signature is invalid

• auth_token_unknown - Failed to parse token

• insufficient_permissions - Insufficient Permissions

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

409

Error Codes:

• too_many_listening_to_single_client - An enumeration.

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

503

Error Codes:

• connection_limit_reached - An enumeration.

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

Loading...