NotificationsService.md

NotificationsService

A list of all methods in the NotificationsService service. Click on the method name to view detailed information about that method.

Methods	Description
getRssNotificationFeed	### Overview Gets your notifications in an RSS Feed which allows you to use them with RSS Feed readers or notification services that can take RSS Feeds and listen to updates. As soon as a notification goes to your account, it will be added to your feed. ### Authorization Requires an API key using as a query parameter using the token key.
getNotificationFeed	### Overview Gets your notifications in a JSON object that is easily parsable compared to the RSS Feed. Gives all the same data as the RSS Feed. ### Authorization Requires an API key using the Authorization Bearer Header.
clearAllNotifications	### Overview Marks all of your notifications as read and deletes them permanently. ### Authorization Requires an API key using the Authorization Bearer Header.
clearSingleNotification	### Overview Marks a single notification as read and permanently deletes it from your notifications. Requires a notification_id which can be found by getting your notification feed. ### Authorization Requires an API key using the Authorization Bearer Header.
sendTestNotification	### Overview Sends a test notification to all enabled notification types. This can be useful for validating setups. No need for any body in this request. ### Authorization Requires an API key using the Authorization Bearer Header.

getRssNotificationFeed

Overview Gets your notifications in an RSS Feed which allows you to use them with RSS Feed readers or notification services that can take RSS Feeds and listen to updates. As soon as a notification goes to your account, it will be added to your feed. ### Authorization Requires an API key using as a query parameter using the token key.

• HTTP Method: GET
• Endpoint: /{api_version}/api/notifications/rss

Parameters

Name	Type	Required	Description
apiVersion	string	✅
token	string	❌

Return Type

any

Example Usage Code Snippet

import { TorboxApi } from '@torbox/@torbox/torbox-api';

(async () => {
  const torboxApi = new TorboxApi({
    token: 'YOUR_TOKEN',
  });

  const { data } = await torboxApi.notifications.getRssNotificationFeed('api_version', {
    token: '{{api_key}}',
  });

  console.log(data);
})();

getNotificationFeed

Overview Gets your notifications in a JSON object that is easily parsable compared to the RSS Feed. Gives all the same data as the RSS Feed. ### Authorization Requires an API key using the Authorization Bearer Header.

• HTTP Method: GET
• Endpoint: /{api_version}/api/notifications/mynotifications

Parameters

Name	Type	Required	Description
apiVersion	string	✅

Return Type

GetNotificationFeedOkResponse

Example Usage Code Snippet

import { TorboxApi } from '@torbox/@torbox/torbox-api';

(async () => {
  const torboxApi = new TorboxApi({
    token: 'YOUR_TOKEN',
  });

  const { data } = await torboxApi.notifications.getNotificationFeed('api_version');

  console.log(data);
})();

clearAllNotifications

Overview Marks all of your notifications as read and deletes them permanently. ### Authorization Requires an API key using the Authorization Bearer Header.

• HTTP Method: POST
• Endpoint: /{api_version}/api/notifications/clear

Parameters

Name	Type	Required	Description
apiVersion	string	✅

Example Usage Code Snippet

import { TorboxApi } from '@torbox/@torbox/torbox-api';

(async () => {
  const torboxApi = new TorboxApi({
    token: 'YOUR_TOKEN',
  });

  const { data } = await torboxApi.notifications.clearAllNotifications('api_version');

  console.log(data);
})();

clearSingleNotification

Overview Marks a single notification as read and permanently deletes it from your notifications. Requires a notification_id which can be found by getting your notification feed. ### Authorization Requires an API key using the Authorization Bearer Header.

• HTTP Method: POST
• Endpoint: /{api_version}/api/notifications/clear/{notification_id}

Parameters

Name	Type	Required	Description
apiVersion	string	✅
notificationId	string	✅

Example Usage Code Snippet

import { TorboxApi } from '@torbox/@torbox/torbox-api';

(async () => {
  const torboxApi = new TorboxApi({
    token: 'YOUR_TOKEN',
  });

  const { data } = await torboxApi.notifications.clearSingleNotification('api_version', 'notification_id');

  console.log(data);
})();

sendTestNotification

Overview Sends a test notification to all enabled notification types. This can be useful for validating setups. No need for any body in this request. ### Authorization Requires an API key using the Authorization Bearer Header.

• HTTP Method: POST
• Endpoint: /{api_version}/api/notifications/test

Parameters

Name	Type	Required	Description
apiVersion	string	✅

Example Usage Code Snippet

import { TorboxApi } from '@torbox/@torbox/torbox-api';

(async () => {
  const torboxApi = new TorboxApi({
    token: 'YOUR_TOKEN',
  });

  const { data } = await torboxApi.notifications.sendTestNotification('api_version');

  console.log(data);
})();