Build and Send a Block Kit Message with Slack API on New event when a visitor changes its signed status from Envoy API

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

Trigger workflow on

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

Next, do this

Build and Send a Block Kit Message with the Slack 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 Slack 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 Build and Send a Block Kit Message action
1. Connect your Slack account
2. Select a Channel
3. Optional- Configure Notification Text
4. Optional- Configure Send as User
5. Optional- Configure Schedule message
6. Optional- Configure Include link to workflow
7. Optional- Configure Customize Bot Settings
8. Optional- Configure Bot Username
9. Optional- Select a Icon (emoji)
10. Optional- Configure Icon (image URL)
11. Optional- Configure Reply to Thread
12. Optional- Configure Message Timestamp
13. Optional- Configure Send Channel Message
14. Optional- Configure Add Message Metadata
15. Optional- Configure Metadata Event Type
16. Optional- Configure Metadata Event Payload
17. Optional- Configure Configure Unfurl Settings
18. Optional- Configure Unfurl Links
19. Optional- Configure Unfurl Media
20. Optional- Select a Add Blocks - Reference Existing Blocks Array or Configure Manually?
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#

Build and Send a Block Kit Message on Slack

Description:Configure custom blocks and send to a channel, group, or user. [See the documentation](https://api.slack.com/tools/block-kit-builder).

Version:0.4.1

Key:slack-send-block-kit-message

View on GitHub

Slack Overview#

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

The Pipedream Slack app is not a typical app. You don't interact with it directly as a bot, and it doesn't add custom functionality to your workspace out of the box. It makes it easier to automate anything you'd typically use the Slack API for, using Pipedream workflows.

Automate posting updates to your team channels
Create a bot to answer common questions
Integrate with your existing tools and services
And much more!

Action Code#

import buildBlocks from "../common/build-blocks.mjs";
import common from "../common/send-message.mjs";

export default {
  ...common,
  ...buildBlocks,
  key: "slack-send-block-kit-message",
  name: "Build and Send a Block Kit Message",
  description: "Configure custom blocks and send to a channel, group, or user. [See the documentation](https://api.slack.com/tools/block-kit-builder).",
  version: "0.4.1",
  type: "action",
  props: {
    slack: common.props.slack,
    conversation: {
      propDefinition: [
        common.props.slack,
        "conversation",
      ],
    },
    text: {
      type: "string",
      label: "Notification Text",
      description: "Optionally provide a string for Slack to display as the new message notification (if you do not provide this, notification will be blank).",
      optional: true,
    },
    ...common.props,
    ...buildBlocks.props,
  },
  methods: {
    ...common.methods,
    ...buildBlocks.methods,
    async getGeneratedBlocks() {
      return await buildBlocks.run.call(this);  // call buildBlocks.run with the current context
    },
  },
  async run({ $ }) {
    this.blocks = await this.getGeneratedBlocks();  // set the blocks prop for common.run to use
    const resp = await common.run.call(this, {
      $,
    });  // call common.run with the current context
    return resp;
  },
};

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
Slack	`slack`	`app`	This component uses the Slack app.
Channel	`conversation`	`string`	Select a value from the drop down menu.
Notification Text	`text`	`string`	Optionally provide a string for Slack to display as the new message notification (if you do not provide this, notification will be blank).
Send as User	`as_user`	`boolean`	Optionally pass `TRUE` to post the message as the authenticated user, instead of as a bot. Defaults to `FALSE`.
Schedule message	`post_at`	`string`	Messages can only be scheduled up to 120 days in advance, and cannot be scheduled for the past. The datetime should be in ISO 8601 format. (Example: `2014-01-01T00:00:00Z`)
Include link to workflow	`include_sent_via_pipedream_flag`	`boolean`	Defaults to `true`, includes a link to the workflow at the end of your Slack message.
Customize Bot Settings	`customizeBotSettings`	`boolean`	Customize the username and/or icon of the Bot
Reply to Thread	`replyToThread`	`boolean`	Reply to an existing thread
Add Message Metadata	`addMessageMetadata`	`boolean`	Set the metadata event type and payload
Configure Unfurl Settings	`configureUnfurlSettings`	`boolean`	Configure settings for unfurling links and media
Add Blocks - Reference Existing Blocks Array or Configure Manually?	`passArrayOrConfigure`	`string`	Select a value from the drop down menu:`{ "label": "Reference an array of blocks", "value": "array" }{ "label": "Configure blocks individually (maximum 5 blocks)", "value": "configure" }`

Action Authentication#

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

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

bookmarks:writecalls:readcalls:writechannels:historychannels:readchannels:writednd:readdnd:writeemoji:readfiles:readgroups:historygroups:readgroups:writeim:historyim:readim:writelinks:readlinks:writempim:historympim:readmpim:writepins:readpins:writereactions:readreactions:writereminders:readreminders:writeremote_files:readremote_files:sharestars:readstars:writeteam:readusergroups:readusergroups:writeusers:readusers:read.emailusers:writechat:write:botchat:write:usercommandsfiles:write:userusers.profile:writeusers.profile:readsearch:read

About Slack#

Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.

More Ways to Connect Slack + Envoy#

Other Popular Integrations#

Create an Invite with Envoy API on New Star Added To Message (Instant) from Slack API

Slack + Envoy

Build and Send a Block Kit Message with Slack API on New event when a visitor changes its signed status from Envoy API

Pipedream makes it easy to connect APIs for Slack, Envoy 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