jonathangomz / onesignal-client

Client for OneSignal API

OneSignal Client for Nodejs

A OneSignal client that implement some of the endpoints from the OneSignal API

Docs

Note: The responses are the direct responses from the provider so you can see the examples on his documentation (See ref).

constructor({ authKey, restApiKey, appId })

Creates a new OneSignal client.

const client = new OneSignal({
  authKey: process.env.AUTH_KEY,
  restApiKey: process.env.REST_API_KEY,
  appId: process.env.APP_ID,
});

isValid(): Promise<boolean | Error>

Validate that the app exist in the provider.

client.isValid()

getApp(): Promise<Response>

View the details of a single OneSignal app.

See more

Usage example:

client.getApp()

sendNotification(message, options?): Promise<Response>

Sends notifications to your users.
If attribute included_segments not provided will send to "Test" segment by default.

See more

Usage example:

const message = {
  heading: {
    en: 'Example Explicit Segment',
    es: 'Ejemplo Segmento Explicito',
  },
  content: {
    en: 'This is an example for Test segment explicitly',
    es: 'Este es un ejemplo para el segmento Test de forma explícita',
  }
}

const opt = {
  targets: {
    to: {
      type: 'external',
      value: ['1130745'],
    }
  }
}

client.sendNotification(message, opt);

cancelNotification(notification_id): Promise<Response>

Stop a scheduled or currently outgoing notification.

See more

Usage example:

client.cancelNotification('fd1723c6-bfaf-4f53-b4f4-0408ff43e18a');

viewNotifications(options?): Promise<Response>

View the details of multiple notifications.

See more

Usage example:

client.viewNotifications({ limit: 5 });

viewNotification(notification_id): Promise<Response>

View the details of a single notification and outcomes associated with it.

See more

Usage example:

client.viewNotification('fd1723c6-bfaf-4f53-b4f4-0408ff43e18a');

viewDevices(options?): Promise<Response>

View the details of multiple devices in your app.

See more

Usage example:

client.viewDevices({ limit: 2 });

viewDevice(player_id): Promise<Response>

View the details of an existing device in your OneSignal apps.

See more

Usage example:

client.viewDevice('fd1723c6-bfaf-4f53-b4f4-0408ff43e18a');

Ref:

https://documentation.onesignal.com/reference