Send Email with Mailgun API on New NPS Ratings from UserVoice API

Pipedream makes it easy to connect APIs for Mailgun, UserVoice and 2,000+ other apps remarkably fast.

Trigger workflow on

New NPS Ratings from the UserVoice 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 UserVoice 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 NPS Ratings trigger
1. Connect your UserVoice account
2. Configure Polling schedule
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 NPS Ratings on UserVoice

Description:Emits new NPS ratings submitted through the UserVoice NPS widget. On first run, emits up to 10 sample NPS ratings users have previously submitted.

Version:0.0.4

Key:uservoice-new-nps-ratings

View on GitHub

UserVoice Overview#

The UserVoice API allows you to tap into customer feedback and support data to automate and enhance customer engagement processes. With the API, you can programmatically access UserVoice accounts to retrieve suggestions, tickets, and user data, allowing you to analyze customer trends, automate responses, and integrate with other customer success platforms. By leveraging Pipedream's capabilities, you can create event-driven workflows that react to UserVoice events, synchronize data across multiple services, and construct a more responsive customer feedback loop.

Trigger Code#

const uservoice = require("../../uservoice.app.js");
const { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } = require("@pipedream/platform");

const NUM_SAMPLE_RESULTS = 10;

module.exports = {
  name: "New NPS Ratings",
  version: "0.0.4",
  key: "uservoice-new-nps-ratings",
  description: `Emits new NPS ratings submitted through the UserVoice NPS widget. On first run, emits up to ${NUM_SAMPLE_RESULTS} sample NPS ratings users have previously submitted.`,
  dedupe: "unique",
  type: "source",
  props: {
    uservoice,
    timer: {
      label: "Polling schedule",
      description:
        "Pipedream will poll the UserVoice API for new NPS ratings on this schedule",
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    db: "$.service.db",
  },
  hooks: {
    async deploy() {
      // Emit sample records on the first run
      const { npsRatings } = await this.uservoice.listNPSRatings({
        numSampleResults: NUM_SAMPLE_RESULTS,
      });
      this.emitWithMetadata(npsRatings);
    },
  },
  methods: {
    emitWithMetadata(ratings) {
      for (const rating of ratings) {
        const {
          id, rating: score, body, created_at,
        } = rating;
        const summary = body && body.length
          ? `${score} - ${body}`
          : `${score}`;
        this.$emit(rating, {
          summary,
          id,
          ts: +new Date(created_at),
        });
      }
    },
  },
  async run() {
    let updated_after =
      this.db.get("updated_after") || new Date().toISOString();
    const {
      npsRatings, maxUpdatedAt,
    } = await this.uservoice.listNPSRatings({
      updated_after,
    });
    this.emitWithMetadata(npsRatings);

    if (maxUpdatedAt) {
      updated_after = maxUpdatedAt;
    }
    this.db.set("updated_after", updated_after);
  },
};

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
UserVoice	`uservoice`	`app`	This component uses the UserVoice app.
Polling schedule	`timer`	`$.interface.timer`	Pipedream will poll the UserVoice API for new NPS ratings on this schedule
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

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

To connect to the UserVoice API, create a trusted API client. In your UserVoice Admin Console, navigate to Settings → Integrations → UserVoice API keys and click the button to Add API Key. Add a name and check the Trusted box at the bottom of the modal that appears:

Then, generate an access token by clicking the Create button near the right of the details of the API key:

About UserVoice#

User feedback made easy and actionable

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`

Action Authentication#

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

About Mailgun#

Mailgun is an email automation service built for developers. Powerful transactional email APIs enable you to send, receive, and track emails.

More Ways to Connect Mailgun + UserVoice#

Other Popular Integrations#

Mailgun Suppress Email with Mailgun API on New NPS Ratings from UserVoice API

UserVoice + Mailgun

Send Email with Mailgun API on New NPS Ratings from UserVoice API

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