Send Email with Mailgun API on New Tweet Metrics from X (Twitter) API

Pipedream makes it easy to connect APIs for Mailgun, X (Twitter) and 2,000+ other apps remarkably fast.

Trigger workflow on

New Tweet Metrics from the X (Twitter) API

Next, do this

Send Email with the Mailgun API

No credit card required

▶

Watch us build a workflow

4 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a X (Twitter) trigger and Mailgun action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Tweet Metrics trigger
1. Connect your X (Twitter) account
2. Configure timer
3. Configure Tweet ID
4. Select one or more Metrics Fields
Configure the Send Email action
1. Connect your Mailgun account
2. Select a Domain Name
3. Configure From Name
4. Configure From Email
5. Optional- Configure Reply-To
6. Configure To
7. Configure Subject
8. Optional- Configure Message Body (text)
9. Optional- Configure Message Body (HTML)
10. Optional- Configure Attachments
11. Configure Send in test mode?
12. Optional- Configure Use DKIM?
13. Optional- Configure Use Tracking?
14. Configure Halt on error?
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 Tweet Metrics on X (Twitter)

Description:Emit new event when a Tweet has new metrics [See the documentation](https://developer.twitter.com/en/docs/twitter-api/metrics)

Version:1.0.6

Key:twitter-new-tweet-metrics

View on GitHub

Trigger Code#

import { defineSource } from "@pipedream/types";
import common from "../common/base.mjs";
import { METRICS_FIELDS } from "../../common/dataFields.mjs";
const DOCS_LINK = "https://developer.twitter.com/en/docs/twitter-api/metrics";
export default defineSource({
    ...common,
    key: "twitter-new-tweet-metrics",
    name: "New Tweet Metrics",
    description: `Emit new event when a Tweet has new metrics [See the documentation](${DOCS_LINK})`,
    version: "1.0.6",
    type: "source",
    props: {
        ...common.props,
        tweetId: {
            propDefinition: [
                common.props.app,
                "tweetId",
            ],
        },
        metricsFields: {
            type: "string[]",
            label: "Metrics Fields",
            description: "The types of metrics to request for the specified Tweet.",
            options: METRICS_FIELDS,
        },
    },
    methods: {
        ...common.methods,
        getSavedMetrics() {
            return this.db.get("savedMetrics");
        },
        setSavedMetrics(data) {
            this.db.set("savedMetrics", data);
        },
        async getAndProcessData() {
            const params = {
                $: this,
                tweetId: this.tweetId,
                params: {
                    "tweet.fields": this.metricsFields?.join(),
                },
            };
            const data = (await this.app.getTweet(params))?.data;
            if (data) {
                const { non_public_metrics, organic_metrics, promoted_metrics, public_metrics, } = data;
                const stringifiedObj = JSON.stringify({
                    non_public_metrics,
                    organic_metrics,
                    promoted_metrics,
                    public_metrics,
                });
                const savedMetrics = this.getSavedMetrics();
                if (savedMetrics !== stringifiedObj) {
                    const ts = Date.now();
                    this.$emit(data, {
                        id: ts,
                        summary: "New Metrics",
                        ts,
                    });
                    this.setSavedMetrics(stringifiedObj);
                }
            }
        },
    },
});

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
X (Twitter)	`app`	`app`	This component uses the X (Twitter) app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Tweet ID	`tweetId`	`string`	The numerical ID of the tweet.
Metrics Fields	`metricsFields`	`string[]`	Select a value from the drop down menu:`public_metricsnon_public_metricsorganic_metricspromoted_metrics`

Trigger Authentication#

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

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

About X (Twitter)#

Formerly known as Twitter. From breaking news and entertainment to sports and politics, get the full story with all the live commentary. Use a X developer app you've created to send API requests.

Action#

Send Email on Mailgun

Description:Send email with Mailgun. [See the docs here](https://documentation.mailgun.com/en/latest/api-sending.html#sending)

Version:0.1.0

Key:mailgun-send-email

View on GitHub

Mailgun Overview#

The Mailgun API on Pipedream is a potent tool for automating email operations without the overhead of managing a full-fledged email server. It offers capabilities to send, receive, track, and store emails with ease. With Pipedream's serverless platform, you can trigger workflows using Mailgun events, such as inbound emails or delivery status changes, and connect them to hundreds of other services to streamline communication, marketing, and notification systems within your ecosystem.

Action Code#

import mailgun from "../../mailgun.app.mjs";
import common from "../common.mjs";
import downloader from "@pipedream/helper_functions/actions/download-file-to-tmp/download-file-to-tmp.mjs";

export default {
  ...common,
  key: "mailgun-send-email",
  name: "Send Email",
  description: "Send email with Mailgun. [See the docs here](https://documentation.mailgun.com/en/latest/api-sending.html#sending)",
  version: "0.1.0",
  type: "action",
  props: {
    mailgun,
    domain: {
      propDefinition: [
        mailgun,
        "domain",
      ],
    },
    fromName: {
      propDefinition: [
        mailgun,
        "name",
      ],
      label: "From Name",
      description: "Sender name",
    },
    from: {
      propDefinition: [
        mailgun,
        "emailString",
      ],
      label: "From Email",
      description: "Sender email address",
    },
    /* eslint-disable pipedream/default-value-required-for-optional-props */
    replyTo: {
      propDefinition: [
        mailgun,
        "emailString",
      ],
      label: "Reply-To",
      description: "Sender reply email address",
      optional: true,
    },
    /* eslint-enable pipedream/default-value-required-for-optional-props */
    to: {
      propDefinition: [
        mailgun,
        "emails",
      ],
      label: "To",
      description: "Recipient email address(es)",
    },
    /* eslint-enable pipedream/default-value-required-for-optional-props */
    subject: {
      propDefinition: [
        mailgun,
        "subject",
      ],
      description: "Message subject",
    },
    text: {
      propDefinition: [
        mailgun,
        "bodyText",
      ],
      optional: true,
    },
    /* eslint-disable pipedream/default-value-required-for-optional-props */
    html: {
      propDefinition: [
        mailgun,
        "bodyHtml",
      ],
      optional: true,
    },
    attachments: {
      type: "object",
      label: "Attachments",
      description: "Add any attachments you'd like to include as objects. The `key` should be " +
       "the **filename** and the `value` should be the **url** download link for the attachment.",
      optional: true,
    },
    /* eslint-enable pipedream/default-value-required-for-optional-props */
    testMode: {
      type: "boolean",
      label: "Send in test mode?",
      default: true,
      description: "Enables sending in test mode. For more information, see the [Mailgun API " +
        "documentation](https://documentation.mailgun.com/en/latest/api-sending.html#sending)",
    },
    dkim: {
      type: "boolean",
      label: "Use DKIM?",
      default: true,
      description: "Enables or disables DKIM signatures. For more information, see the [Mailgun " +
        "API documentation](https://documentation.mailgun.com/en/latest/api-sending.html#sending)",
      optional: true,
    },
    tracking: {
      type: "boolean",
      label: "Use Tracking?",
      default: true,
      description: "Enables or disables tracking. For more information, see the [Mailgun API " +
        "documentation](https://documentation.mailgun.com/en/latest/api-sending.html#sending)",
      optional: true,
    },
    ...common.props,
  },
  methods: {
    ...common.methods,
    async download($, attachments) {
      const promises = Object.entries(attachments).map(async ([
        filename,
        url,
      ]) => downloader.run.bind({
        url,
        filename,
      })({
        $,
      }));

      return (await Promise.all(promises))
        .map((filedata) => this.createAttachment(filedata[3], filedata[0]));
    },
    createAttachment(data, filename) {
      return {
        data,
        filename,
      };
    },
  },
  async run({ $ }) {
    const msg = {
      "from": `${this.fromName} <${this.from}>`,
      "to": this.to,
      "subject": this.subject,
      "text": this.text,
      "html": this.html,
    };
    if (this.attachments) {
      msg["attachment"] = await this.download($, this.attachments);
    }
    if (this.testMode) {
      msg["o:testmode"] = "yes";
    }
    if (this.replyTo) {
      msg["h:Reply-To"] = this.replyTo;
    }
    if (this.dkim !== null) {
      msg["o:dkim"] = this.dkim
        ? "yes"
        : "no";
    }
    if (this.tracking) {
      msg["o:tracking"] = "yes";
    }
    const resp = await this.withErrorHandler(this.mailgun.sendMail, {
      domain: this.domain,
      msg,
    });
    $.export("filedata", null); // remove set filedata from downloader
    $.export("$summary", "Successfully sent email.");
    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
Mailgun	`mailgun`	`app`	This component uses the Mailgun app.
Domain Name	`domain`	`string`	Select a value from the drop down menu.
From Name	`fromName`	`string`	Sender name
From Email	`from`	`string`	Sender email address
Reply-To	`replyTo`	`string`	Sender reply email address
To	`to`	`string[]`	Recipient email address(es)
Subject	`subject`	`string`	Message subject
Message Body (text)	`text`	`string`
Message Body (HTML)	`html`	`string`
Attachments	`attachments`	`object`	Add any attachments you'd like to include as objects. The `key` should be the filename and the `value` should be the url download link for the attachment.
Send in test mode?	`testMode`	`boolean`	Enables sending in test mode. For more information, see the Mailgun API documentation
Use DKIM?	`dkim`	`boolean`	Enables or disables DKIM signatures. For more information, see the Mailgun API documentation
Use Tracking?	`tracking`	`boolean`	Enables or disables tracking. For more information, see the Mailgun API documentation
Halt on error?	`haltOnError`	`boolean`

Send Email with Mailgun API on New Tweet Metrics from X (Twitter) API

Pipedream makes it easy to connect APIs for Mailgun, X (Twitter) and 2,000+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,000+apps by most popular

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