Add Device with OneSignal (REST API) API

Pipedream makes it easy to connect APIs for OneSignal (REST API) and 1,600+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Add Device with the OneSignal (REST API) API

No credit card required

▶

Watch us build a workflow

7 min

Watch now ➜

Trusted by 750,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Add Device with the OneSignal (REST API) API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Add Device action
1. Connect your OneSignal (REST API) account
2. Select a Device Type
3. Optional- Configure Identifier
4. Optional- Configure Timezone
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Add Device with OneSignal (REST API) API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + OneSignal (REST API)

Try it

Add Device with OneSignal (REST API) API on New Message from Discord API

Discord + OneSignal (REST API)

Try it

Add Device with OneSignal (REST API) API on New Message In Channels from Slack API

Slack + OneSignal (REST API)

Try it

Add Device with OneSignal (REST API) API on New Message in Channel from Discord Bot API

Discord Bot + OneSignal (REST API)

Try it

Add Device with OneSignal (REST API) API on New Submission from Typeform API

Typeform + OneSignal (REST API)

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Add Device on OneSignal (REST API)

Description:Register a new device to your app. [See docs here](https://documentation.onesignal.com/reference/add-a-device)

Version:0.0.1652718586

Key:onesignal_rest_api-add-device

View on GitHub

Code#

import onesignalRestApi from "../../onesignal_rest_api.app.mjs";
import constants from "../common/constants.mjs";

export default {
  key: "onesignal_rest_api-add-device",
  name: "Add Device",
  description: "Register a new device to your app. [See docs here](https://documentation.onesignal.com/reference/add-a-device)",
  version: "0.0.1652718586",
  type: "action",
  props: {
    onesignalRestApi,
    deviceType: {
      label: "Device Type",
      description: "The device's platform. E.g. 0 = iOS, 1 = Android...",
      type: "string",
      options: constants.DEVICE_TYPES,
    },
    identifier: {
      label: "Identifier",
      description: "For Push Notifications, this is the Push Token Identifier from Google or Apple.",
      type: "string",
      optional: true,
    },
    timezone: {
      label: "Timezone",
      description: "Number of seconds away from UTC. E.g. -28800",
      type: "integer",
      optional: true,
    },
  },
  async run({ $ }) {
    console.log({
      device_type: this.deviceType,
      identifier: this.identifier,
      timezone: this.timezone,
    });
    const response = await this.onesignalRestApi.addDevice({
      data: {
        device_type: +this.deviceType,
        identifier: this.identifier,
        timezone: this.timezone,
      },
      $,
    });

    $.export("$summary", "Successfully added device.");

    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
OneSignal (REST API)	`onesignalRestApi`	`app`	This component uses the OneSignal (REST API) app.
Device Type	`deviceType`	`string`	Select a value from the drop down menu:`{ "label": "iOS", "value": "0" }{ "label": "Android", "value": "1" }{ "label": "Amazon", "value": "2" }{ "label": "WindowsPhone (MPNS)", "value": "3" }{ "label": "Chrome Apps / Extensions", "value": "4" }{ "label": "Chrome Web Push", "value": "5" }{ "label": "Windows (WNS)", "value": "6" }{ "label": "Safari", "value": "7" }{ "label": "Firefox", "value": "8" }{ "label": "MacOS", "value": "9" }{ "label": "Alexa", "value": "10" }{ "label": "Email", "value": "11" }{ "label": "For Huawei App Gallery Builds SDK Setup. Not for Huawei Devices using FCM", "value": "13" }{ "label": "SMS", "value": "14" }`
Identifier	`identifier`	`string`	For Push Notifications, this is the Push Token Identifier from Google or Apple.
Timezone	`timezone`	`integer`	Number of seconds away from UTC. E.g. -28800