Return HTTP Response with HTTP / Webhook API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Return HTTP Response with the HTTP / Webhook 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#

Create a workflow to Return HTTP Response with the HTTP / Webhook API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

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
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Return HTTP Response with HTTP / Webhook API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + HTTP / Webhook

Try it

Return HTTP Response with HTTP / Webhook API on New Message from Discord API

Discord + HTTP / Webhook

Try it

Return HTTP Response with HTTP / Webhook API on New Message in Channel from Discord Bot API

Discord Bot + HTTP / Webhook

Try it

Return HTTP Response with HTTP / Webhook API on New Submission from Typeform API

Typeform + HTTP / Webhook

Try it

Return HTTP Response with HTTP / Webhook API on Custom Events from Zoom API

Zoom + 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.

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

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

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
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.

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 Use HTTP / Webhook#

Triggers#

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