Return HTTP Response with HTTP / Webhook API on New NPS Ratings from UserVoice API

Pipedream makes it easy to connect APIs for HTTP / Webhook, UserVoice and 2,400+ other apps remarkably fast.

Trigger workflow on

New NPS Ratings from the UserVoice API

Next, do this

Return HTTP Response with the HTTP / Webhook 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 UserVoice trigger and HTTP / Webhook 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 Return HTTP Response action
1. Connect your HTTP / Webhook account
2. Configure Response Status Code
3. Optional- Configure Response Headers
4. Optional- Configure Response Body
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#

Return HTTP Response on HTTP / Webhook

Description:Use with an HTTP trigger that uses "Return a custom response from your workflow" as its `HTTP Response`

Version:0.0.3

Key:http-return-http-response

View on GitHub

HTTP / Webhook Overview#

Build, test, and send HTTP requests without code using your Pipedream workflows. The HTTP / Webhook action is a tool to build HTTP requests with a Postman-like graphical interface.

Point and click HTTP requests

Define the target URL, HTTP verb, headers, query parameters, and payload body without writing custom code.

$A screenshot of Pipedream's HTTP Request Configuration interface with a GET request type selected. The request URL is set to 'https://api.openai.com/v1/models'. The 'Auth' tab is highlighted, indicating that authentication is required for this request. In the headers section, there are two headers configured: 'User-Agent' is set to 'pipedream/1', and 'Authorization' is set to 'Bearer {{openai_api_key}}', showing how the OpenAI account's API key is dynamically inserted into the headers to handle authentication automatically.$

Here's an example workflow that uses the HTTP / Webhook action to send an authenticated API request to OpenAI.

Focus on integrating, not authenticating

This action can also use your connected accounts with third-party APIs. Selecting an integrated app will automatically update the request’s headers to authenticate with the app properly, and even inject your token dynamically.

Pipedream integrates with thousands of APIs, but if you can’t find a Pipedream integration simply use Environment Variables in your request headers to authenticate with.

Compatible with no code actions or Node.js and Python

The HTTP/Webhook action exports HTTP response data for use in subsequent workflow steps, enabling easy data transformation, further API calls, database storage, and more.

Response data is available for both coded (Node.js, Python) and no-code steps within your workflow.

Action Code#

import http from "../../http.app.mjs";

export default {
  key: "http-return-http-response",
  name: "Return HTTP Response",
  description:
    "Use with an HTTP trigger that uses \"Return a custom response from your workflow\" as its `HTTP Response`",
  type: "action",
  version: "0.0.3",
  props: {
    http,
    resStatusCode: {
      type: "integer",
      label: "Response Status Code",
      description:
        "The [status code](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status) to return in the HTTP response.",
      default: 200,
      min: 100,
      max: 599,
    },
    resHeaders: {
      type: "object",
      label: "Response Headers",
      description: "The headers to return in the HTTP response.",
      optional: true,
    },
    resBody: {
      type: "any",
      label: "Response Body",
      description: "The body to return in the HTTP response.",
      optional: true,
      default: "{ \"success\": true }",
    },
  },
  async run({ $ }) {
    const status = this.resStatusCode;
    await $.respond({
      status,
      headers: this.resHeaders,
      body: this.resBody,
    });
    $.export("$summary", `Responded successfully with status ${status}`);
  },
};

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
HTTP / Webhook	`http`	`app`	This component uses the HTTP / Webhook app.
Response Status Code	`resStatusCode`	`integer`	The status code to return in the HTTP response.
Response Headers	`resHeaders`	`object`	The headers to return in the HTTP response.
Response Body	`resBody`	`any`	The body to return in the HTTP response.

Action Authentication#

The HTTP / Webhook API does not require authentication.

About HTTP / Webhook#

Get a unique URL where you can send HTTP or webhook requests

More Ways to Connect HTTP / Webhook + UserVoice#

Other Popular Integrations#

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

UserVoice + HTTP / Webhook

Try it

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

UserVoice + HTTP / Webhook

Try it

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

UserVoice + HTTP / Webhook

Try it

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

UserVoice + HTTP / Webhook

Try it

Validate Webhook Auth with HTTP / Webhook API on New NPS Ratings from UserVoice API

UserVoice + HTTP / Webhook

Try it

Popular Triggers#

New NPS Ratings from the UserVoice API

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

Try it

New Requests from the HTTP / Webhook API

Get a URL and emit the full HTTP event on every request (including headers and query parameters). You can also configure the HTTP response code, body, and more.

Try it

New Requests (Payload Only) from the HTTP / Webhook API

Get a URL and emit the HTTP body as an event on every request

Try it

New event when the content of the URL changes. from the HTTP / Webhook API

Emit new event when the content of the URL changes.

Try it