Notifications v2

Reference for the Notifications v2 endpoints on Roblox.

Base URL: https://notifications.roblox.com

Endpoints

Method	Path	Name
`GET`	`/v2/push-notifications/chrome-manifest`	`getPushNotificationsChromeManifest`
`POST`	`/v2/push-notifications/deregister-all-devices`	`postPushNotificationsDeregisterAllDevices`
`POST`	`/v2/push-notifications/deregister-current-device`	`postPushNotificationsDeregisterCurrentDevice`
`POST`	`/v2/push-notifications/deregister-current-device-ios-pushkit`	`postPushNotificationsDeregisterCurrentDeviceIosPushkit`
`GET`	`/v2/push-notifications/get-current-device-destination`	`getPushNotificationsGetCurrentDeviceDestination`
`GET`	`/v2/push-notifications/get-destinations`	`getPushNotificationsGetDestinations`
`GET`	`/v2/push-notifications/metadata`	`getPushNotificationsMetadata`
`POST`	`/v2/push-notifications/register-android-native`	`postPushNotificationsRegisterAndroidNative`
`POST`	`/v2/push-notifications/register-ios-native`	`postPushNotificationsRegisterIosNative`
`POST`	`/v2/push-notifications/register-ios-pushkit`	`postPushNotificationsRegisterIosPushkit`
`POST`	`/v2/stream-notifications/clear-unread`	`postStreamNotificationsClearUnread`
`GET`	`/v2/stream-notifications/get-latest-game-updates`	`getStreamNotificationsGetLatestGameUpdates`
`GET`	`/v2/stream-notifications/get-recent`	`getStreamNotificationsGetRecent`
`GET`	`/v2/stream-notifications/metadata`	`getStreamNotificationsMetadata`
`GET`	`/v2/stream-notifications/unread-count`	`getStreamNotificationsUnreadCount`

`getPushNotificationsChromeManifest`

GET /v2/push-notifications/chrome-manifest

Get Chrome Manifest to link GCM project to Chrome Browser

Usage

import { fetchApi } from 'rozod';
import { getPushNotificationsChromeManifest } from 'rozod/endpoints/notificationsv2';

const data = await fetchApi(getPushNotificationsChromeManifest, undefined);

Response

Field	Type	Description
`name`	`string`
`gcm_sender_id`	`string`

Errors

Status	Description
401	0: Authorization has been denied for this request.

`postPushNotificationsDeregisterAllDevices`

POST /v2/push-notifications/deregister-all-devices

De-register all devices to disable push notifications

Usage

import { fetchApi } from 'rozod';
import { postPushNotificationsDeregisterAllDevices } from 'rozod/endpoints/notificationsv2';

const data = await fetchApi(postPushNotificationsDeregisterAllDevices, undefined);

Response

Field	Type	Description
`statusMessage`	`string`

Errors

Status	Description
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed

`postPushNotificationsDeregisterCurrentDevice`

POST /v2/push-notifications/deregister-current-device

De-register current device to disable push notifications

Usage

import { fetchApi } from 'rozod';
import { postPushNotificationsDeregisterCurrentDevice } from 'rozod/endpoints/notificationsv2';

const data = await fetchApi(postPushNotificationsDeregisterCurrentDevice, undefined);

Response

Field	Type	Description
`statusMessage`	`string`

Errors

Status	Description
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed

`postPushNotificationsDeregisterCurrentDeviceIosPushkit`

POST /v2/push-notifications/deregister-current-device-ios-pushkit

De-register current device to disable pushkit notifications

Usage

import { fetchApi } from 'rozod';
import { postPushNotificationsDeregisterCurrentDeviceIosPushkit } from 'rozod/endpoints/notificationsv2';

const data = await fetchApi(postPushNotificationsDeregisterCurrentDeviceIosPushkit, undefined);

Response

Field	Type	Description
`statusMessage`	`string`

Errors

Status	Description
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed

`getPushNotificationsGetCurrentDeviceDestination`

GET /v2/push-notifications/get-current-device-destination

Gets the current device destination

Usage

import { fetchApi } from 'rozod';
import { getPushNotificationsGetCurrentDeviceDestination } from 'rozod/endpoints/notificationsv2';

const data = await fetchApi(getPushNotificationsGetCurrentDeviceDestination, undefined);

Response

Field	Type	Description
`destination`	`object`	See below
`statusMessage`	`string`

destination fields:

Field	Type	Description
`user`	`object`	See below
`name`	`string`
`notificationToken`	`string`
`supportsUpdateNotifications`	`boolean`
`userPushNotificationDestinationId`	`number`
`application`	`string`
`platform`	`“ChromeOnDesktop”	“AndroidNative”

user fields:

Field	Type	Description
`name`	`string`
`userId`	`number`

Errors

Status	Description
401	0: Authorization has been denied for this request.

`getPushNotificationsGetDestinations`

GET /v2/push-notifications/get-destinations

Gets valid destinations associated with the signed user

Usage

import { fetchApi } from 'rozod';
import { getPushNotificationsGetDestinations } from 'rozod/endpoints/notificationsv2';

const data = await fetchApi(getPushNotificationsGetDestinations, undefined);

Response

Field	Type	Description
`destinations`	`object[]`	See below
`statusMessage`	`string`

destinations[] item fields:

Field	Type	Description
`user`	`object`	See below
`name`	`string`
`notificationToken`	`string`
`supportsUpdateNotifications`	`boolean`
`userPushNotificationDestinationId`	`number`
`application`	`string`
`platform`	`“ChromeOnDesktop”	“AndroidNative”

user fields:

Field	Type	Description
`name`	`string`
`userId`	`number`

Errors

Status	Description
401	0: Authorization has been denied for this request.

`getPushNotificationsMetadata`

GET /v2/push-notifications/metadata

Gets the corresponding metadata for the specified notification

Usage

import { fetchApi } from 'rozod';
import { getPushNotificationsMetadata } from 'rozod/endpoints/notificationsv2';

const data = await fetchApi(getPushNotificationsMetadata, {
  notificationToken: /* string */,
  notificationId: /* string */
});

Parameters

Name	Type	Required	Description
`notificationToken`	`string`	Yes	Token for the notification
`notificationId`	`string`	Yes	Id of the specified notification

Response

Field	Type	Description
`metadata`	`object`	See below
`statusMessage`	`string`

metadata fields:

Field	Type	Description
`notificationId`	`string`
`type`	`string`
`detail`	`object`	See below
`fallbackDelivered`	`boolean`

Errors

Status	Description
401	0: Authorization has been denied for this request.

`postPushNotificationsRegisterAndroidNative`

POST /v2/push-notifications/register-android-native

Usage

import { fetchApi } from 'rozod';
import { postPushNotificationsRegisterAndroidNative } from 'rozod/endpoints/notificationsv2';

const data = await fetchApi(postPushNotificationsRegisterAndroidNative, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`notificationToken`	`string`
`authorizeForUser`	`boolean`
`oldNotificationToken`	`string`
`deviceName`	`string`

Response

Field	Type	Description
`registration`	`object`	See below
`statusMessage`	`string`

registration fields:

Field	Type	Description
`userPushNotificationDestinationId`	`number`
`name`	`string`
`notificationToken`	`string`
`application`	`string`
`platform`	`“ChromeOnDesktop”	“AndroidNative”

Errors

Status	Description
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed

`postPushNotificationsRegisterIosNative`

POST /v2/push-notifications/register-ios-native

Registers IOS device for push notifications

Usage

import { fetchApi } from 'rozod';
import { postPushNotificationsRegisterIosNative } from 'rozod/endpoints/notificationsv2';

const data = await fetchApi(postPushNotificationsRegisterIosNative, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`notificationToken`	`string`
`destinationIdentifier`	`string`
`authorizeForUser`	`boolean`
`oldNotificationToken`	`string`
`deviceName`	`string`
`isProvisional`	`boolean`

Response

Field	Type	Description
`registration`	`object`	See below
`statusMessage`	`string`

registration fields:

Field	Type	Description
`userPushNotificationDestinationId`	`number`
`name`	`string`
`notificationToken`	`string`
`application`	`string`
`platform`	`“ChromeOnDesktop”	“AndroidNative”

Errors

Status	Description
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed

`postPushNotificationsRegisterIosPushkit`

POST /v2/push-notifications/register-ios-pushkit

Registers IOS device for pushkit notifications

Usage

import { fetchApi } from 'rozod';
import { postPushNotificationsRegisterIosPushkit } from 'rozod/endpoints/notificationsv2';

const data = await fetchApi(postPushNotificationsRegisterIosPushkit, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`notificationToken`	`string`
`destinationIdentifier`	`string`
`authorizeForUser`	`boolean`
`oldNotificationToken`	`string`
`deviceName`	`string`

Response

Field	Type	Description
`registration`	`object`	See below
`statusMessage`	`string`

registration fields:

Field	Type	Description
`userPushNotificationDestinationId`	`number`
`name`	`string`
`notificationToken`	`string`
`application`	`string`
`platform`	`“ChromeOnDesktop”	“AndroidNative”

Errors

Status	Description
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed

`postStreamNotificationsClearUnread`

POST /v2/stream-notifications/clear-unread

Clears the unread Notification stream count

Usage

import { fetchApi } from 'rozod';
import { postStreamNotificationsClearUnread } from 'rozod/endpoints/notificationsv2';

const data = await fetchApi(postStreamNotificationsClearUnread, undefined);

Response

Field	Type	Description
`statusMessage`	`string`

Errors

Status	Description
401	0: Authorization has been denied for this request.
403	0: Token Validation Failed

`getStreamNotificationsGetLatestGameUpdates`

GET /v2/stream-notifications/get-latest-game-updates

Get the latest non aggregated Game Updates sent to the logged in user

Usage

import { fetchApi } from 'rozod';
import { getStreamNotificationsGetLatestGameUpdates } from 'rozod/endpoints/notificationsv2';

const data = await fetchApi(getStreamNotificationsGetLatestGameUpdates, {
  universeIds: /* number */,
  sinceDateTime: /* string */
});

Parameters

Name	Type	Required	Description
`universeIds`	`number`	Yes	List of universe IDs
`sinceDateTime`	`string`	Yes	For retrieving only updates that created after a time point.

Response

Array of objects:

Field	Type	Description
`universeId`	`number`
`rootPlaceId`	`number`
`createdOn`	`string`
`createdOnKey`	`string`
`content`	`string`
`universeName`	`string`

Errors

Status	Description
401	0: Authorization has been denied for this request.

`getStreamNotificationsGetRecent`

GET /v2/stream-notifications/get-recent

Gets the recent entries from the notification stream

Usage

import { fetchApi } from 'rozod';
import { getStreamNotificationsGetRecent } from 'rozod/endpoints/notificationsv2';

const data = await fetchApi(getStreamNotificationsGetRecent, {
  startIndex: /* integer? */,
  maxRows: /* integer? = 10 */
});

Parameters

Name	Type	Required	Description
`startIndex`	`integer?`	No	Index to start the entries from. (Optional : Defaults to 0 which means the most recent entry)
`maxRows`	`integer? = 10`	No	Number of entries to be returned. (Optional : Defaults to 10 entries)

Response

Array of objects:

Field	Type	Description
`id`	`string`
`notificationSourceType`	`“Test”	“FriendRequestReceived”
`eventDate`	`string`
`timestamp`	`string`
`isInteracted`	`boolean`
`metadataCollection`	`unknown[]`
`eventCount`	`number`
`content`	`object`	See below

Errors

Status	Description
401	0: Authorization has been denied for this request.

`getStreamNotificationsMetadata`

GET /v2/stream-notifications/metadata

Get Notification Stream metadata.

Usage

import { fetchApi } from 'rozod';
import { getStreamNotificationsMetadata } from 'rozod/endpoints/notificationsv2';

const data = await fetchApi(getStreamNotificationsMetadata, undefined);

Response

Field	Type	Description
`bannerDismissTimeSpan`	`number`
`signalRDisconnectionResponseInMilliseconds`	`number`
`canLaunchGameFromGameUpdate`	`boolean`

Errors

Status	Description
401	0: Authorization has been denied for this request.

`getStreamNotificationsUnreadCount`

GET /v2/stream-notifications/unread-count

Gets the count of unread Notification stream entries

Usage

import { fetchApi } from 'rozod';
import { getStreamNotificationsUnreadCount } from 'rozod/endpoints/notificationsv2';

const data = await fetchApi(getStreamNotificationsUnreadCount, undefined);

Response

Field	Type	Description
`unreadNotifications`	`number`
`statusMessage`	`string`

Errors

Status	Description
401	0: Authorization has been denied for this request.