Create Space with Workast API on New Message in Channel from Discord Bot API

Pipedream makes it easy to connect APIs for Workast, Discord Bot and 1200+ other apps remarkably fast.

Trigger workflow on

New Message in Channel from the Discord Bot API

Next, do this

Create Space with the Workast 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 Workast 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 Space action
1. Connect your Workast account
2. Configure Name
3. Optional- Configure Description
4. Optional- Select one or more Participants Ids
5. Optional- Select a Type
6. Optional- Select a Privacy
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 Space on Workast

Description:Creates a space. [See docs here](https://developers.workast.com/#/method/createSpace)

Version:0.0.1

Key:workast-create-space

View on GitHub

Workast Overview#

The Workast API allows developers to create powerful applications for
streamlining the process of task management. With the Workast API, you can
build applications that will help users automate their personal and
professional task management workflow.

Here are some examples of what you can build using the Workast API:

Task Management Systems: You can build applications to help users manage
their tasks, reminders, and subtasks.
Collaboration Platforms: With the Workast API, you can create an application
to help teams collaborate on tasks and share updates in real-time.
Project Dashboards: You can create an application that will help users
visualize the progress of their projects.
Scheduling: Applications that integrate with calendars, to help users create
and manage their schedules.
Reporting: With the Workast API, you can build application with reporting
capabilities, to help users track their task progress and keep track of their
team’s progress.
Database Management: You can create an application to help users store and
organize their data.
Time Tracking: Create an application that helps users keep track of their
time and track the progress of their tasks.

Action Code#

import { defineAction } from "@pipedream/types";
import workast from "../../app/workast.app.mjs";
import constants from "../common/constants.mjs";
export default defineAction({
    name: "Create Space",
    version: "0.0.1",
    key: "workast-create-space",
    description: "Creates a space. [See docs here](https://developers.workast.com/#/method/createSpace)",
    type: "action",
    props: {
        workast,
        name: {
            label: "Name",
            description: "The space name",
            type: "string",
        },
        description: {
            label: "Description",
            description: "The space description",
            type: "string",
            optional: true,
        },
        userIds: {
            label: "Participants Ids",
            description: "The user ID to assigne to the task",
            type: "string[]",
            propDefinition: [
                workast,
                "userId",
            ],
            optional: true,
        },
        type: {
            label: "Type",
            description: "The type of the space",
            type: "string",
            options: constants.SPACE_TYPES,
            optional: true,
        },
        privacy: {
            label: "Privacy",
            description: "The privacy of the space",
            type: "string",
            options: constants.SPACE_PRIVACIES,
            optional: true,
        },
    },
    async run({ $ }) {
        const participantsParsed = typeof this.userIds === "string"
            ? JSON.parse(this.userIds)
            : this.userIds;
        const response = await this.workast.createSpace({
            $,
            data: {
                name: this.name,
                description: this.description,
                participants: participantsParsed ?? [],
                type: this.type,
                privacy: this.privacy,
            },
        });
        if (response) {
            $.export("$summary", `Successfully created space with id ${response.id}`);
        }
        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
Workast	`workast`	`app`	This component uses the Workast app.
Name	`name`	`string`	The space name
Description	`description`	`string`	The space description
Participants Ids	`userIds`	`string[]`	Select a value from the drop down menu.
Type	`type`	`string`	Select a value from the drop down menu:`{ "label": "Direct", "value": "direct" }{ "label": "Group", "value": "group" }{ "label": "Template", "value": "template" }`
Privacy	`privacy`	`string`	Select a value from the drop down menu:`{ "label": "Private", "value": "private" }{ "label": "Team", "value": "team" }`

Action Authentication#

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

To retrieve your API key:

Navigate to your Workast account and sign in
In Chrome you need to open the Developers tools (View -> Developer -> Developer tools)
Go to the Application tab
Navigate to cookies and you will find a cookie called token
Remember to URL decode the token before you use it with a tool like https://www.urldecoder.org/