Send Email with Elastic Email API on New event when a visitor is invited from Envoy API

Pipedream makes it easy to connect APIs for Elastic Email, Envoy and 2,700+ other apps remarkably fast.

Trigger workflow on

New event when a visitor is invited from the Envoy API

Next, do this

Send Email with the Elastic Email 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 Elastic Email 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 is invited trigger
1. Connect your Envoy account
2. Configure Watching timer
Configure the Send Email action
1. Connect your Elastic Email account
2. Configure Recipients
3. Configure From
4. Optional- Select a Body Content Type
5. Optional- Configure Body Content
6. Optional- Configure Merge
7. Optional- Configure Reply To
8. Optional- Configure Subject
9. Optional- Select a Template Name
10. Optional- Configure Time Offset
11. Optional- Configure Pool Name
12. Optional- Configure Channel Name
13. Optional- Select a Encoding
14. Optional- Configure Track Opens
15. Optional- Configure Track Clicks
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 is invited on Envoy

Description:Emit new event for each invitations to a person or a group of people to visit a location. [See the docs](https://developers.envoy.com/hub/reference/invites-2).

Version:0.0.1

Key:envoy-visitor-invited

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

export default {
  key: "envoy-visitor-invited",
  name: "New event when a visitor is invited",
  description: "Emit new event for each invitations to a person or a group of people to visit a location. [See the docs](https://developers.envoy.com/hub/reference/invites-2).",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    app,
    timer: {
      type: "$.interface.timer",
      label: "Watching timer",
      description: "How often to watch the summaries.",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  methods: {
    emit(meta) {
      const ts = Date.parse(meta.createdAt);
      this.$emit(meta, {
        id: meta.id,
        summary: `New invite: ${meta.invitee?.name || meta.id}`,
        ts,
      });
    },
  },
  async run({ $ }) {
    const result = await this.app.listInvites($, {
      sort: "CREATED_AT",
      order: "DESC",
    });
    for (const invite of result.data) {
      this.emit(invite);
    }
  },
};

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.
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 Email on Elastic Email

Description:Sends an email to one or more recipients. [See the documentation](https://elasticemail.com/developers/api-documentation/rest-api#operation/emailsPost)

Version:0.0.1

Key:elastic_email-send-email

View on GitHub

Elastic Email Overview#

The Elastic Email API allows you to integrate a robust email sending platform into your Pipedream workflows. Use it to send emails, manage contacts, and track campaign statistics. With this API, you can automate email notifications, synchronize subscriber lists, or trigger marketing campaigns based on user actions.

Action Code#

import {
  BODY_CONTENT_TYPE_OPTIONS,
  ENCODING_OPTIONS,
} from "../../common/constants.mjs";
import { parseObject } from "../../common/utils.mjs";
import app from "../../elastic_email.app.mjs";

export default {
  key: "elastic_email-send-email",
  name: "Send Email",
  description: "Sends an email to one or more recipients. [See the documentation](https://elasticemail.com/developers/api-documentation/rest-api#operation/emailsPost)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    recipients: {
      type: "string[]",
      label: "Recipients",
      description: "List of recipients",
    },
    from: {
      type: "string",
      label: "From",
      description: "Your e-mail with an optional name (e.g.: email@domain.com)",
    },
    bodyContentType: {
      type: "string",
      label: "Body Content Type",
      description: "Type of body part",
      options: BODY_CONTENT_TYPE_OPTIONS,
      optional: true,
    },
    bodyContent: {
      type: "string",
      label: "Body Content",
      description: "Actual content of the body part",
      optional: true,
    },
    merge: {
      type: "object",
      label: "Merge",
      description: "A key-value collection of custom merge fields, shared between recipients. Should be used in e-mail body like so: {firstname}, {lastname} etc.",
      optional: true,
    },
    replyTo: {
      type: "string",
      label: "Reply To",
      description: "To what address should the recipients reply to (e.g. email@domain.com)",
      optional: true,
    },
    subject: {
      type: "string",
      label: "Subject",
      description: "Default subject of email.",
      optional: true,
    },
    templateName: {
      propDefinition: [
        app,
        "templateName",
      ],
      optional: true,
    },
    timeOffset: {
      type: "integer",
      label: "Time Offset",
      description: "By how long should an e-mail be delayed (in minutes). Maximum is 35 days.",
      optional: true,
    },
    poolName: {
      type: "string",
      label: "Pool Name",
      description: "Name of your custom IP Pool to be used in the sending process",
      optional: true,
    },
    channelName: {
      type: "string",
      label: "Channel Name",
      description: "Name of selected channel.",
      optional: true,
    },
    encoding: {
      type: "string",
      label: "Encoding",
      description: "Encoding type for the email headers",
      options: ENCODING_OPTIONS,
      optional: true,
    },
    trackOpens: {
      type: "boolean",
      label: "Track Opens",
      description: "Should the opens be tracked? If no value has been provided, Account's default setting will be used.",
      optional: true,
    },
    trackClicks: {
      type: "boolean",
      label: "Track Clicks",
      description: "Should the clicks be tracked? If no value has been provided, Account's default setting will be used.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.app.sendBulkEmails({
      $,
      data: {
        Recipients: parseObject(this.recipients)?.map((item) => ({
          Email: item,
        })),
        Content: {
          From: this.from,
          Body: [
            {
              ContentType: this.bodyContentType,
              Body: this.bodyContent,
            },
          ],
          Merge: parseObject(this.merge),
          ReplyTo: this.replyTo,
          Subject: this.subject,
          TemplateName: this.templateName,
        },
        Options: {
          TimeOffset: this.timeOffset,
          PoolName: this.poolName,
          ChannelName: this.channelName,
          Encoding: this.encoding,
          TrackOpens: this.trackOpens,
          TrackClicks: this.trackClicks,
        },
      },
    });
    $.export("$summary", `Emails sent successfully to ${this.recipients.join(", ")}`);
    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
Elastic Email	`app`	`app`	This component uses the Elastic Email app.
Recipients	`recipients`	`string[]`	List of recipients
From	`from`	`string`	Your e-mail with an optional name (e.g.: email@domain.com)
Body Content Type	`bodyContentType`	`string`	Select a value from the drop down menu:`HTMLPlainTextAMPCSS`
Body Content	`bodyContent`	`string`	Actual content of the body part
Merge	`merge`	`object`	A key-value collection of custom merge fields, shared between recipients. Should be used in e-mail body like so: {firstname}, {lastname} etc.
Reply To	`replyTo`	`string`	To what address should the recipients reply to (e.g. email@domain.com)
Subject	`subject`	`string`	Default subject of email.
Template Name	`templateName`	`string`	Select a value from the drop down menu.
Time Offset	`timeOffset`	`integer`	By how long should an e-mail be delayed (in minutes). Maximum is 35 days.
Pool Name	`poolName`	`string`	Name of your custom IP Pool to be used in the sending process
Channel Name	`channelName`	`string`	Name of selected channel.
Encoding	`encoding`	`string`	Select a value from the drop down menu:`UserProvidedNoneRaw7bitRaw8bitQuotedPrintableBase64Uue`
Track Opens	`trackOpens`	`boolean`	Should the opens be tracked? If no value has been provided, Account's default setting will be used.
Track Clicks	`trackClicks`	`boolean`	Should the clicks be tracked? If no value has been provided, Account's default setting will be used.

Action Authentication#

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

You can get your API Key in the Manage API Key page.

About Elastic Email#

All the email marketing and delivery tools you need to communicate with your customers. Most attractive monthly pricing and pay-as-you-go option on the market.