Send Message with Discord API on New event when a visitor changes its signed status from Envoy API

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

Trigger workflow on

New event when a visitor changes its signed status from the Envoy API

Next, do this

Send Message 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 Envoy 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 New event when a visitor changes its signed status trigger
1. Connect your Envoy account
2. Select one or more Signed Status
3. Configure Watching timer
Configure the Send Message action
1. Connect your Discord account
2. Configure channel
3. 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
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 event when a visitor changes its signed status on Envoy

Description:Emit new event for each visitor who signed in or out. [See the docs](https://developers.envoy.com/hub/reference/entries-2).

Version:0.0.1

Key:envoy-visitor-signed-status-changed

View on GitHub

Envoy Overview#

The Envoy API empowers users to streamline workplace operations, particularly visitor management, deliveries, and room bookings. Leveraging Pipedream's capabilities, you can automate tasks involving these aspects. For example, you can receive notifications when guests arrive, sync visitor data with other systems, or automate the creation and management of room bookings.

Trigger Code#

import app from "../../envoy.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import { ConfigurationError } from "@pipedream/platform";
import constants from "../common/constants.mjs";

export default {
  key: "envoy-visitor-signed-status-changed",
  name: "New event when a visitor changes its signed status",
  description: "Emit new event for each visitor who signed in or out. [See the docs](https://developers.envoy.com/hub/reference/entries-2).",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    app,
    signedStatus: {
      type: "string[]",
      label: "Signed Status",
      description: "Should emit events for which signed status.",
      options: constants.SIGNED_STATUS_OPTS,
    },
    timer: {
      type: "$.interface.timer",
      label: "Watching timer",
      description: "How often to watch the summaries.",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  methods: {
    emit(meta, signedStatus) {
      const ts = Date.parse(meta.createdAt);
      this.$emit(meta, {
        id: `${meta.id}-${meta.signedInAt}-${meta.signedOutAt}`,
        summary: `Visitor ${signedStatus}: ${meta.fullName}`,
        ts,
      });
    },
  },
  async run({ $ }) {
    let today = new Date();
    today.setHours(0, 0, 0, 0);

    if (this.signedStatus.length === 0) {
      throw new ConfigurationError("Signed status is required.");
    }

    const signedInResponse = await this.app.listAllEntriesPages($, {
      signedInAtAfter: today.toISOString(),
      sort: "SIGNED_IN_AT",
      order: "ASC",
    });

    // emitting signed in
    if (this.signedStatus.find((status) => (status === constants.SIGNED_IN))) {
      for (const entry of signedInResponse.filter((entry) => (entry.signedOutAt === null))) {
        this.emit(entry, constants.SIGNED_IN.toLocaleLowerCase());
      }
    }

    // emitting signed out
    if (this.signedStatus.find((status) => (status === constants.SIGNED_OUT))) {
      for (const entry of signedInResponse.filter((entry) => (entry.signedOutAt !== null))) {
        this.emit(entry, constants.SIGNED_OUT.toLocaleLowerCase());
      }
    }
  },
};

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
Envoy	`app`	`app`	This component uses the Envoy app.
Signed Status	`signedStatus`	`string[]`	Select a value from the drop down menu:`Signed inSigned out`
Watching timer	`timer`	`$.interface.timer`	How often to watch the summaries.

Trigger Authentication#

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

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

locations.readcompanies.reademployees.readtoken.refreshinvites.readentries.readinvites.write

About Envoy#

Join thousands of companies that rely on Envoy to efficiently manage hybrid workplaces, so everyone inside can connect, collaborate, and thrive.

Action#

Send Message on Discord

Description:Send a simple message to a Discord channel

Version:1.0.3

Key:discord-send-message

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

export default {
  ...common,
  key: "discord-send-message",
  name: "Send Message",
  description: "Send a simple message to a Discord channel",
  version: "1.0.3",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  async run({ $ }) {
    const {
      message,
      avatarURL,
      threadID,
      username,
      includeSentViaPipedream,
      suppressNotifications,
    } = this;
    try {
      const resp = await this.discord.sendMessage(this.channel, {
        avatar_url: avatarURL,
        username,
        flags: this.getMessageFlags(suppressNotifications),
        content: includeSentViaPipedream
          ? this.appendPipedreamText(message)
          : message,
      }, {
        thread_id: threadID,
      });
      $.export("$summary", "Message sent successfully");
      return resp || {
        success: true,
      };
    } catch (err) {
      console.log(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.

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