Create Notification with OneSignal (REST API) API on New Message in Channel from Discord Bot API

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

Trigger workflow on

New Message in Channel from the Discord Bot API

Next, do this

Create Notification with the OneSignal (REST API) API

No credit card required

▶

Watch us build a workflow

7 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Discord Bot 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 Message in Channel trigger
1. Connect your Discord Bot account
2. Select a Guild
3. Select one or more Channels
4. Optional- Configure Emit messages as a single event
5. Configure timer
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 Message in Channel on Discord Bot

Description:Emit new event for each message posted to one or more channels

Version:0.0.12

Key:discord_bot-new-message-in-channel

View on GitHub

Discord Bot Overview#

The Pipedream Discord app enables you to build event-driven workflows that interact with the Discord API. When you authorize the Pipedream app's access to your guilds, you can use Pipedream workflows to perform common Discord actions, or write your own code against the Discord API.

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import maxBy from "lodash.maxby";
import common from "../common.mjs";

const { discord } = common.props;

export default {
  ...common,
  key: "discord_bot-new-message-in-channel",
  name: "New Message in Channel",
  description: "Emit new event for each message posted to one or more channels",
  type: "source",
  version: "0.0.12",
  dedupe: "unique", // Dedupe events based on the Discord message ID
  props: {
    ...common.props,
    db: "$.service.db",
    channels: {
      type: "string[]",
      label: "Channels",
      description: "The channels you'd like to watch for new messages",
      propDefinition: [
        discord,
        "channelId",
        ({ guildId }) => ({
          guildId,
        }),
      ],
    },
    emitEventsInBatch: {
      type: "boolean",
      label: "Emit messages as a single event",
      description:
        "If `true`, all messages are emitted as an array, within a single Pipedream event. Defaults to `false`, emitting each Discord message as its own event in Pipedream",
      optional: true,
      default: false,
    },
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  async run({ $ }) {
    // We store a cursor to the last message ID
    let lastMessageIDs = this._getLastMessageIDs();

    // If this is our first time running this source,
    // get the last N messages, emit them, and checkpoint
    for (const channelId of this.channels) {
      let lastMessageID;
      let messages = [];

      if (!lastMessageID) {
        messages = await this.discord.getMessages({
          $,
          channelId,
          params: {
            limit: 100,
          },
        });

        lastMessageID = messages.length
          ? maxBy(messages, (message) => message.id).id
          : 1;

      } else {
        let newMessages = [];

        do {
          newMessages = await this.discord.getMessages({
            $,
            channelId,
            params: {
              after: lastMessageIDs[channelId],
            },
          });

          messages = messages.concat(newMessages);

          lastMessageID = newMessages.length
            ? maxBy(newMessages, (message) => message.id).id
            : lastMessageIDs[channelId];

        } while (newMessages.length);
      }

      // Set the new high water mark for the last message ID
      // for this channel
      lastMessageIDs[channelId] = lastMessageID;

      if (!messages.length) {
        console.log(`No new messages in channel ${channelId}`);
        return;
      }

      console.log(`${messages.length} new messages in channel ${channelId}`);

      // Batched emits do not take advantage of the built-in deduper
      if (this.emitEventsInBatch) {
        const suffixChar =
          messages.length > 1
            ? "s"
            : "";

        this.$emit(messages, {
          summary: `${messages.length} new message${suffixChar}`,
          id: lastMessageID,
        });

      } else {
        messages.forEach((message) => {
          this.$emit(message, {
            summary: message.content,
            id: message.id, // dedupes events based on this ID
          });
        });
      }
    }

    // Set the last message ID for the next run
    this._setLastMessageIDs(lastMessageIDs);
  },
};

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
Discord Bot	`discord`	`app`	This component uses the Discord Bot app.
Guild	`guildId`	`string`	Select a value from the drop down menu.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Channels	`channels`	`string[]`	Select a value from the drop down menu.
Emit messages as a single event	`emitEventsInBatch`	`boolean`	If `true`, all messages are emitted as an array, within a single Pipedream event. Defaults to `false`, emitting each Discord message as its own event in Pipedream
	`timer`	`$.interface.timer`

Trigger Authentication#

Discord Bot uses API keys for authentication. When you connect your Discord Bot account, Pipedream securely stores the keys so you can easily authenticate to Discord Bot APIs in both code and no-code steps.

This app allows you to use the Discord API using your own Discord bot. If you don't want to use a custom bot, and you just need to use the Discord API, exit this screen and use the Discord app, instead.

If you want to use your own Discord bot, but haven't created one yet, see these instructions or watch this video. You'll need to add this bot to your server(s) to make successful API requests.

Once you've created your bot, you'll find the Bot token within the Bot section of your app. Enter that token below.

About Discord Bot#

Use this app to interact with the Discord API using a bot in your account

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#

With the OneSignal (REST API) API, you can create powerful tools to connect
with your users and build an engaged audience. The API enables you to create,
read, update, and delete push notifications, set up segmentation, and deliver
messages to players.

The API also enables you to:

Monitor and analyze performance with analytics dashboards and reporting tools
Receive updates on user engagement with real-time events
Automate message sending using scheduled notifications
Personalize messages using data gathered on each user

These are just some of the resources available to you when you use OneSignal
API:

Create targeted notifications for user-specific behaviors
Trigger personalized messages via segmentation
Maintain continuity with automated, scheduled messages
Develop group messages and alert campaigns
Analyze user engagement with reporting tools
Mark individual push notifications as delivered or failed

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