New NPS Ratings from UserVoice API

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

Trigger workflow on

New NPS Ratings from the UserVoice API

Next, do this

Connect to 2,000+ APIs using code and no-code building blocks

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#

Trigger a workflow on New NPS Ratings with UserVoice API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the New NPS Ratings trigger
1. Connect your UserVoice account
2. Configure Polling schedule
Add steps to connect to 2,000+ APIs using code and no-code building blocks
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Send Message with Discord Webhook API on New NPS Ratings from UserVoice API

UserVoice + Discord Webhook

Try it

Add Multiple Rows with Google Sheets API on New NPS Ratings from UserVoice API

UserVoice + Google Sheets

Try it

Get Film with SWAPI API on New NPS Ratings from UserVoice API

UserVoice + SWAPI - Star Wars

Try it

Create Multiple Records with Airtable API on New NPS Ratings from UserVoice API

UserVoice + Airtable (API Key)

Try it

Custom Request with HTTP / Webhook API on New NPS Ratings from UserVoice API

UserVoice + HTTP / Webhook

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

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

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);
  },
};

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.

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: