Add Device with OneSignal (REST API) API on Custom Interval from Schedule API

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

Trigger workflow on

Custom Interval from the Schedule API

Next, do this

Add Device with the OneSignal (REST API) API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Schedule trigger and OneSignal (REST API) action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Custom Interval trigger
1. Connect your Schedule account
2. Configure Cron Schedule
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
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

Custom Interval on Schedule

Description:Trigger your workflow every N hours, minutes or seconds.

Version:0.0.2

Key:schedule-custom-interval

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

import schedule from "../../schedule.app.mjs";

export default {
  name: "Custom Interval",
  version: "0.0.2",
  key: "schedule-custom-interval",
  type: "source",
  description: "Trigger your workflow every N hours, minutes or seconds.",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
    },
  },
};

Trigger 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
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

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

OneSignal (REST API) Overview#

OneSignal's REST API enables developers to automate the delivery of push notifications, manage users and segments, and gather analytics to refine communication strategies. By integrating OneSignal with Pipedream, you can orchestrate complex workflows that react to events or schedules, synchronize user data across platforms, and personalize user engagement with cross-channel marketing tools.

Action 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;
  },
};

Action Configuration#

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

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