← FaunaDB + Discord Webhook integrations

Send Message (Advanced) with Discord Webhook API on New or Removed Documents in a Collection from FaunaDB API

Pipedream makes it easy to connect APIs for Discord Webhook, FaunaDB and 900+ other apps remarkably fast.

Trigger workflow on
New or Removed Documents in a Collection from the FaunaDB API
Next, do this
Send Message (Advanced) with the Discord Webhook API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

This integration creates a workflow with a FaunaDB trigger and Discord Webhook action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Select this integration
  2. Configure the New or Removed Documents in a Collection trigger
    1. Configure timer
    2. Connect your FaunaDB account
    3. Select a Collection
    4. Optional- Configure Emit changes as a single event
  3. Configure the Send Message (Advanced) action
    1. Connect your Discord Webhook account
    2. Optional- Configure Message
    3. Optional- Configure Thread ID
    4. Optional- Configure Username
    5. Optional- Configure Avatar URL
    6. Optional- Configure Include link to workflow
    7. Optional- Configure Embeds
  4. Deploy the workflow
  5. Send a test event to validate your setup
  6. Turn on the trigger

Details

This integration uses pre-built, open source 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

Description:Emit new event each time you add or remove a document from a specific collection, with the details of the document.
Version:0.0.7
Key:faunadb-changes-to-collection

Trigger Code

import fauna from "../../faunadb.app.mjs";
import _ from "lodash";

export default {
  type: "source",
  key: "faunadb-changes-to-collection",
  name: "New or Removed Documents in a Collection",
  description: "Emit new event each time you add or remove a document from a specific collection, with the details of the document.",
  version: "0.0.7",
  dedupe: "unique", // Dedupe events based on the concatenation of event + document ref id
  props: {
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: 5 * 60,
      },
    },
    db: "$.service.db",
    fauna,
    collection: {
      propDefinition: [
        fauna,
        "collections",
      ],
    },
    emitEventsInBatch: {
      type: "boolean",
      label: "Emit changes as a single event",
      description:
        "If `true`, all events are emitted as an array, within a single Pipedream event. Defaults to `false`, emitting each event in Fauna as its own event in Pipedream",
      optional: true,
      default: false,
    },
  },
  async run() {
    // As soon as the script runs, mark the start time so we can fetch changes
    // since this time on the next run. Fauna expects epoch ms as its cursor.
    const ts = +new Date() * 1000;
    const cursor = this.db.get("cursor") || ts;

    const events = await this.fauna.getEventsInCollectionAfterTs(
      this.collection,
      cursor,
    );

    if (!events.length) {
      console.log(`No new events in collection ${this.collection}`);
      this.db.set("cursor", ts);
      return;
    }

    console.log(`${events.length} new events in collection ${this.collection}`);

    // Batched emits do not take advantage of the built-in deduper
    if (this.emitEventsInBatch) {
      this.$emit({
        events,
      }, {
        summary: `${events.length} new event${events.length > 1
          ? "s"
          : ""}`,
        id: cursor,
      });
    } else {
      for (const event of events) {
        this.$emit(event, {
          summary: `${event.action.toUpperCase()} - ${event.document.id}`,
          id: `${event.action}-${event.document.id}`, // dedupes events based on this ID
        });
      }
    }

    // Finally, set cursor for the next run to the max timestamp of the changed events, ensuring we
    // get all events after that on the next run. We need to add 1 since the timestamp filter in
    // Fauna is inclusive: https://docs.fauna.com/fauna/current/api/fql/functions/paginate
    const maxEventTs = _.maxBy(events, (event) => event.ts).ts + 1;

    this.db.set("cursor", maxEventTs);
  },
};

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.
LabelPropTypeDescription
timer$.interface.timer
N/Adb$.service.dbThis component uses $.service.db to maintain state between component invocations.
FaunaDBfaunaappThis component uses the FaunaDB app.
CollectioncollectionstringSelect a value from the drop down menu.
Emit changes as a single eventemitEventsInBatchboolean

If true, all events are emitted as an array, within a single Pipedream event. Defaults to false, emitting each event in Fauna as its own event in Pipedream

Trigger Authentication

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

Create a key in the Security section of your FaunaDB dashboard, then enter the Secret below.

Read more about Keys and Fauna Security.

About FaunaDB

The database built for serverless, featuring native GraphQL

Action

Description:Send a simple or structured message (using embeds) to a Discord channel
Version:0.3.1
Key:discord_webhook-send-message-advanced

Discord Webhook Overview

With Discord's Webhook API, you can create applications that send messages to
Discord channels automatically. For example, you could create a bot that sends
a message to a channel every time a new blog post is published, or a message to
a channel when someone joins your Discord server.

Here are some ideas for what you could build using the Discord Webhook API:

  • A bot that sends a message to a channel when a new blog post is published
  • A bot that sends a message to a channel when someone joins your Discord
    server
  • A bot that sends a message to a channel when a new product is added to your
    online store

Action Code

import common from "../send-message-common.mjs";

export default {
  ...common,
  key: "discord_webhook-send-message-advanced",
  name: "Send Message (Advanced)",
  description: "Send a simple or structured message (using embeds) to a Discord channel",
  version: "0.3.1",
  type: "action",
  props: {
    ...common.props,
    message: {
      propDefinition: [
        common.props.discordWebhook,
        "message",
      ],
      optional: true,
    },
    embeds: {
      propDefinition: [
        common.props.discordWebhook,
        "embeds",
      ],
    },
  },
  async run({ $ }) {
    const {
      message,
      avatarURL,
      threadID,
      username,
      includeSentViaPipedream,
      embeds,
    } = this;

    if (!message && !embeds) {
      throw new Error("This action requires at least 1 message OR embeds object. Please enter one or the other above.");
    }

    try {
      // No interesting data is returned from Discord
      await this.discordWebhook.sendMessage({
        avatarURL,
        threadID,
        username,
        embeds,
        content: includeSentViaPipedream
          ? this.appendPipedreamText(message ?? "")
          : message,
      });
      $.export("$summary", "Message sent successfully");
    } 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.

LabelPropTypeDescription
Discord WebhookdiscordWebhookappThis component uses the Discord Webhook app.
Messagemessagestring

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 IDthreadIDstring

If provided, the message will be posted to this thread

Usernameusernamestring

Overrides the current username of the webhook

Avatar URLavatarURLstring

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 workflowincludeSentViaPipedreamboolean

Defaults to true, includes a link to this workflow at the end of your Discord message.

Embedsembedsany

Optionally pass an array of embed objects. E.g., {{ [{"description":"Use markdown including *Italic* **bold** __underline__ ~~strikeout~~ [hyperlink](https://google.com) `code`"}] }}. To pass data from another step, enter a reference using double curly brackets (e.g., {{steps.mydata.$return_value}}).
Tip: Construct the embeds array in a Node.js code step, return it, and then pass the return value to this step.

Action Authentication

Discord Webhook uses OAuth authentication. When you connect your Discord Webhook account, Pipedream will open a popup window where you can sign into Discord Webhook 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 Webhook API.

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

webhook.incomingemailidentify

About Discord Webhook

Use this app to send messages to a channel using Discord's incoming webhooks

More Ways to Connect Discord Webhook + FaunaDB

Send Message with Discord Webhook API on New or Removed Documents in a Collection from FaunaDB API
FaunaDB + Discord Webhook
 
Try it
Send Message With File with Discord Webhook API on New or Removed Documents in a Collection from FaunaDB API
FaunaDB + Discord Webhook
 
Try it
New or Removed Documents in a Collection from the FaunaDB API

Emit new event each time you add or remove a document from a specific collection, with the details of the document.

 
Try it
Execute GraphQL Query with the FaunaDB API

Performs an arbitrary authorized GraphQL query. See docs here

 
Try it
Import GraphQL schema with the FaunaDB API

Import graphQL schema to a database. See docs here

 
Try it
Read From FaunaDB Collection with the FaunaDB API

Reads all documents from a given FaunaDB collection. See docs here

 
Try it
Send Message with the Discord Webhook API

Send a simple message to a Discord channel

 
Try it
Send Message (Advanced) with the Discord Webhook API

Send a simple or structured message (using embeds) to a Discord channel

 
Try it