Create a subscription

POST

http://localhost:4002/rest/v1/notifications/subscriptions

Notifications

Last modified:2026-09-23 05:22:50

Maintainer:Not configured

Schedules a notification for a game or game event. Duplicate subscriptions
(same resident, entity, trigger and offset) are ignored silently.
offset_days is only stored when trigger_type is days_before.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Header Params

Body Params application/jsonRequired

Examples

Notify on release dayNotify 3 days before release

{
    "entity_type": "game",
    "entity_id": "game_123",
    "trigger_type": "on_release",
    "notify_at": "2026-10-01T00:00:00.000Z"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

Notify on release dayNotify 3 days before release

curl --location 'http://localhost:4002/rest/v1/notifications/subscriptions' \
--header 'X-Nexus-Key: ' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "entity_type": "game",
    "entity_id": "game_123",
    "trigger_type": "on_release",
    "notify_at": "2026-10-01T00:00:00.000Z"
}'

Responses

🟢201

Subscription created (no body)

This response does not have a body.

🟠400BadRequest

🟠401Unauthorized

Modified at 2026-09-23 05:22:50

Upsert a preference

Delete a subscription