Create Notification with OneSignal (REST API) API on New Order from Thanks.io API

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

Trigger workflow on

New Order from the Thanks.io API

Next, do this

Create Notification 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 Thanks.io 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 New Order trigger
1. Connect your Thanks.io account
2. Configure Polling interval
3. Optional- Select a Sub Account
Configure the Create Notification action
1. Connect your OneSignal (REST API) account
2. Optional- Configure Name
3. Optional- Configure Included Segments
4. Configure Contents
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#

New Order on Thanks.io

Description:Emit new event for each new order placed.

Version:0.0.3

Key:thanks_io-new-order

View on GitHub

Thanks.io Overview#

The Thanks.io API lets you automate the sending of personalized postcards and letters. This API can be harnessed to craft tailored outreach campaigns, customer appreciation notes, or event-based mailings. By integrating with Pipedream, you can create intelligent, event-driven workflows that trigger mailings based on user activity, data changes, or milestones achieved in other apps, streamlining the way businesses and developers connect with their audiences physically.

Trigger Code#

import common from "../common/common.mjs";

export default {
  ...common,
  key: "thanks_io-new-order",
  name: "New Order",
  description: "Emit new event for each new order placed.",
  version: "0.0.3",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    generateMeta(order) {
      return {
        id: order.id,
        summary: `New Order ID: ${order.id}`,
        ts: Date.parse(order?.created_at?.date),
      };
    },
  },
  async run() {
    const lastCreated = this._getLastTimestamp();
    let newLastCreated = lastCreated;

    const params = lastCreated
      ? {}
      : {
        items_per_page: 25,
      };
    if (this.subaccount) {
      params.sub_account_id = this.subaccount;
    }

    const { data: orders } = await this.thanksIo.listOrders({
      params,
    });
    for (const order of orders) {
      const createdAt = Date.parse(order.created_at.date);
      if (this.isLater(createdAt, lastCreated)) {
        this.$emit(order, this.generateMeta(order));
      }
      if (this.isLater(createdAt, newLastCreated)) {
        newLastCreated = createdAt;
      }
    }

    this._setLastTimestamp(newLastCreated);
  },
};

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
Thanks.io	`thanksIo`	`app`	This component uses the Thanks.io app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling interval	`timer`	`$.interface.timer`	Pipedream will poll the API on this schedule
Sub Account	`subAccount`	`string`	Select a value from the drop down menu.

Trigger Authentication#

Thanks.io uses OAuth authentication. When you connect your Thanks.io account, Pipedream will open a popup window where you can sign into Thanks.io and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Thanks.io API.

Pipedream requests the following authorization scopes when you connect your account:

About Thanks.io#

Direct Mail Sent Digitally

Action#

Create Notification on OneSignal (REST API)

Description:Create a notification. [See docs here](https://documentation.onesignal.com/reference/create-notification)

Version:0.1.1652718586

Key:onesignal_rest_api-create-notification

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";

export default {
  key: "onesignal_rest_api-create-notification",
  name: "Create Notification",
  description: "Create a notification. [See docs here](https://documentation.onesignal.com/reference/create-notification)",
  version: "0.1.1652718586",
  type: "action",
  props: {
    onesignalRestApi,
    name: {
      label: "Name",
      description: "The name of the campaign",
      type: "string",
      optional: true,
    },
    included_segments: {
      label: "Included Segments",
      description: "The segment names you want to target. E.g. [\"Active Users\", \"Inactive Users\"]",
      type: "string[]",
      optional: true,
    },
    contents: {
      label: "Contents",
      description: "The notification's content (excluding the title), a map of language codes to text for each language. E.g. {\"en\": \"English Message\", \"es\": \"Spanish Message\"}",
      type: "object",
    },
  },
  async run({ $ }) {
    const response = await this.onesignalRestApi.sendNotification({
      data: {
        name: this.name,
        included_segments: this.included_segments,
        contents: typeof this.contents === "string"
          ? JSON.parse(this.contents)
          : this.contents,
      },
      $,
    });

    $.export("$summary", "Successfully created notification.");

    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.
Name	`name`	`string`	The name of the campaign
Included Segments	`included_segments`	`string[]`	The segment names you want to target. E.g. ["Active Users", "Inactive Users"]
Contents	`contents`	`object`	The notification's content (excluding the title), a map of language codes to text for each language. E.g. {"en": "English Message", "es": "Spanish Message"}