Send Message With File with Discord API on Catalog Item Updated from Square API

Pipedream makes it easy to connect APIs for Discord, Square and 2,400+ other apps remarkably fast.

Trigger workflow on

Catalog Item Updated from the Square API

Next, do this

Send Message With File with the Discord 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 Square trigger and Discord action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Catalog Item Updated trigger
1. Connect your Square account
2. Configure timer
Configure the Send Message With File action
1. Connect your Discord account
2. Configure channel
3. Optional- Configure Message
4. Optional- Configure Thread ID
5. Optional- Configure Username
6. Optional- Configure Avatar URL
7. Optional- Configure Include link to workflow
8. Optional- Configure Suppress notifications
9. Optional- Configure File URL
10. Optional- Configure File Path
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#

Catalog Item Updated on Square

Description:Emit new event every time a catalog item is updated. [See the docs](https://developer.squareup.com/reference/square/catalog-api/list-catalog)

Version:0.0.3

Key:square-catalog-item-updated

View on GitHub

Square Overview#

The Square API opens up a realm of possibilities for merchants to effortlessly manage their sales, inventory, customers, and payments. With Pipedream, you can automate actions based on events in Square, such as new transactions, updated orders, or customer profile changes. Craft custom workflows that react in real-time, sync data across platforms, or streamline reporting. Through Pipedream's serverless platform, you can connect Square with countless other apps without writing extensive code, turning manual tasks into automated, efficient processes.

Trigger Code#

import base from "../common/base-polling.mjs";
import constants from "../common/constants.mjs";

export default {
  ...base,
  key: "square-catalog-item-updated",
  name: "Catalog Item Updated",
  description: "Emit new event every time a catalog item is updated. [See the docs](https://developer.squareup.com/reference/square/catalog-api/list-catalog)",
  type: "source",
  version: "0.0.3",
  dedupe: "unique",
  hooks: {
    ...base.hooks,
    async deploy() {
      console.log(`Retrieving at most last ${constants.MAX_HISTORICAL_EVENTS} objects...`);
      const { objects } = await this.square.listCatalogItems({
        params: {
          ...this.getBaseParams(),
        },
      });
      if (!(objects?.length > 0)) {
        return;
      }

      let newLastTs = 0;
      for (const object of objects.slice(0, constants.MAX_HISTORICAL_EVENTS)) {
        if (Date.parse(object.updated_at) > newLastTs) {
          newLastTs = Date.parse(object.updated_at);
        }
        this.$emit(object, this.generateMeta(object));
      }
      this._setLastTs(newLastTs);
    },
  },
  methods: {
    ...base.methods,
    getBaseParams() {
      return {
        limit: constants.MAX_LIMIT,
        types: "ITEM",
      };
    },
    generateMeta(object) {
      const ts = Date.parse(object.updated_at);
      return {
        id: `${object.id}${ts}`,
        summary: `Catalog Item Updated: ${object.id}`,
        ts,
      };
    },
  },
  async run() {
    const lastTs = this._getLastTs();
    let newLastTs = lastTs;
    let cursor;

    do {
      const response = await this.square.listCatalogItems({
        params: {
          ...this.getBaseParams(),
          cursor,
        },
      });
      const { objects } = response;
      if (!(objects?.length > 0)) {
        break;
      }
      for (const object of objects) {
        if (Date.parse(object.updated_at) > lastTs) {
          newLastTs = Date.parse(object.updated_at);
        }
        this.emitEvent(object);
      }
      cursor = response?.cursor;
    } while (cursor);

    this._setLastTs(newLastTs);
  },
};

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
Square	`square`	`app`	This component uses the Square app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

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

CUSTOMERS_READCUSTOMERS_WRITEPAYMENTS_READPAYMENTS_WRITEORDERS_READORDERS_WRITESUBSCRIPTIONS_READSUBSCRIPTIONS_WRITEITEMS_READITEMS_WRITEINVOICES_READINVOICES_WRITELOYALTY_READLOYALTY_WRITEEMPLOYEES_READEMPLOYEES_WRITEMERCHANT_PROFILE_READBANK_ACCOUNTS_READSETTLEMENTS_READDEVELOPER_APPLICATION_WEBHOOKS_WRITEAPPOINTMENTS_ALL_READAPPOINTMENTS_READ

About Square#

Solutions & Tools to Grow Your Business

Action#

Send Message With File on Discord

Description:Post a message with an attached file

Version:1.1.1

Key:discord-send-message-with-file

View on GitHub

Discord Overview#

The Discord API interacts seamlessly with Pipedream, empowering you to craft customized automations and workflows for your Discord server. With this powerful integration, you can automate tasks like message posting, user management, and notifications, based on a myriad of triggers and actions from different apps. These automations can enhance the Discord experience for community moderators and members, by synchronizing with external tools, organizing community engagement, and streamlining notifications.

Action Code#

import common from "../common/common.mjs";
import { axios } from "@pipedream/platform";
import fs from "fs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  ...common,
  key: "discord-send-message-with-file",
  name: "Send Message With File",
  description: "Post a message with an attached file",
  version: "1.1.1",
  type: "action",
  props: {
    ...common.props,
    message: {
      propDefinition: [
        common.props.discord,
        "message",
      ],
      optional: true,
    },
    fileUrl: {
      propDefinition: [
        common.props.discord,
        "fileUrl",
      ],
    },
    filePath: {
      propDefinition: [
        common.props.discord,
        "filePath",
      ],
    },
  },
  async run({ $ }) {
    const {
      message,
      avatarURL,
      threadID,
      username,
      fileUrl,
      filePath,
      includeSentViaPipedream,
      suppressNotifications,
    } = this;

    if (!fileUrl && !filePath) {
      throw new ConfigurationError("This action requires either File URL or File Path. Please enter one or the other above.");
    }

    const file = fileUrl
      ? await axios($, {
        method: "get",
        url: fileUrl,
        responseType: "stream",
      })
      : fs.createReadStream(filePath);

    try {
      const resp = await this.discord.sendMessage(this.channel, {
        avatar_url: avatarURL,
        username,
        file,
        flags: this.getMessageFlags(suppressNotifications),
        content: includeSentViaPipedream
          ? this.appendPipedreamText(message ?? "")
          : message,
      }, {
        thread_id: threadID,
      });
      $.export("$summary", "Message sent successfully");
      return resp || {
        success: true,
      };
    } catch (err) {
      const unsentMessage = this.getUserInputProps();
      $.export("unsent", unsentMessage);
      throw err;
    }
  },
};

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
Discord	`discord`	`app`	This component uses the Discord app.
channel	`channel`	`$.discord.channel`
Message	`message`	`string`	Enter a simple message up to 2000 characters. This is the most commonly used field. However, it's optional if you pass embed content.
Thread ID	`threadID`	`string`	If provided, the message will be posted to this thread
Username	`username`	`string`	Overrides the current username of the webhook
Avatar URL	`avatarURL`	`string`	If used, it overrides the default avatar of the webhook. Note: Consecutive posts by the same username within 10 minutes of each other will not display updated avatar.
Include link to workflow	`includeSentViaPipedream`	`boolean`	Defaults to `true`, includes a link to this workflow at the end of your Discord message.
Suppress notifications	`suppressNotifications`	`boolean`	Defaults to `false`, sends the message as silent, triggers no notifications to clients.
File URL	`fileUrl`	`string`	The URL of the file to attach. Must specify either File URL or File Path.
File Path	`filePath`	`string`	The path to the file, e.g. `/tmp/myFile.csv`. Must specify either File URL or File Path.

Action Authentication#

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

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

botemailidentifyguilds

About Discord#

Use this app to create a Discord source that emits messages from your guild to a Pipedream workflow.

More Ways to Connect Discord + Square#

Other Popular Integrations#

Send Message (Advanced) with Discord API on Catalog Item Updated from Square API

Square + Discord

Send Message With File with Discord API on Catalog Item Updated from Square API

Pipedream makes it easy to connect APIs for Discord, Square and 2,400+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular