← HTTP / Webhook

Custom Request with HTTP / Webhook API

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

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Custom Request with the HTTP / Webhook API
No credit card required
Trusted by 200,000+ developers from startups to Fortune 500 companies:
Trusted by 200,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

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

  1. Configure the Custom Request action
    1. Connect your HTTP / Webhook account
    2. Configure URL
    3. Select a Method
    4. Optional- Configure HTTP Body / Payload
    5. Optional- Configure Query Parameters
    6. Optional- Configure HTTP Headers
    7. Optional- Configure Basic Auth
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Details

This is a pre-built, open source 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.

Custom Request on HTTP / Webhook
Description:Make an HTTP request using any method and URL. Optionally configure query string parameters, headers and basic auth.
Version:0.1.1
Key:http-custom-request

Code

import { axios } from "@pipedream/platform";
import http from "../../http.app.mjs";

export default {
  key: "http-custom-request",
  name: "Custom Request",
  description: "Make an HTTP request using any method and URL. Optionally configure query string parameters, headers and basic auth.",
  type: "action",
  version: "0.1.1",
  props: {
    http,
    url: {
      propDefinition: [
        http,
        "url",
      ],
    },
    method: {
      propDefinition: [
        http,
        "method",
      ],
    },
    data: {
      propDefinition: [
        http,
        "body",
      ],
    },
    params: {
      propDefinition: [
        http,
        "params",
      ],
    },
    headers: {
      propDefinition: [
        http,
        "headers",
      ],
    },
    auth: {
      propDefinition: [
        http,
        "auth",
      ],
    },
  },
  async run({ $ }) {
    const {
      data,
      headers,
      method,
      params,
      url,
    } = this;
    const config = {
      url,
      method,
      data,
      params,
      headers,
    };
    if (this.auth) config.auth = this.http.parseAuth(this.auth);
    return await axios($, config);
  },
}
;

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.
LabelPropTypeDescription
HTTP / WebhookhttpappThis component uses the HTTP / Webhook app.
URLurlstring

The URL you'd like to send the HTTP request to

MethodmethodstringSelect a value from the drop down menu:GETPOSTPUTPATCHDELETEHEADOPTIONS
HTTP Body / Payloaddatastring

The body of the HTTP request. Enter a static value or reference prior step exports via the steps object (e.g., {{steps.foo.$return_value}}).

Query Parametersparamsobject

Add individual query parameters as key-value pairs or disable structured mode to pass multiple key-value pairs as an object.

HTTP Headersheadersobject

Add individual HTTP headers as key-value pairs or disable structured mode to pass multiple key-value pairs as an object.

Basic Authauthstring

To use HTTP basic authentication, enter a username and password separated by | (e.g., myUsername|myPassword).

Authentication

The HTTP / Webhook API does not require authentication.

About HTTP / Webhook

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

About Pipedream

Stop writing boilerplate code, struggling with authentication and managing infrastructure. Start connecting APIs with code-level control when you need it — and no code when you don't.

Into to Pipedream
Watch us build a workflow
Watch us build a workflow
4 min
Watch now ➜
"The past few weeks, I truly feel like the clichéd 10x engineer."
@heyellieday
Powerful features that scale
Manage concurrency and execution rate
Manage concurrency and execution rate

Queue up to 10,000 events per workfow and manage the concurrency and rate at which workflows are triggered.

Process large payloads up to 5 terabytes
Process large payloads up to 5 terabytes

Large file support enables you to trigger workflows with any data (e.g., large JSON files, images and videos) up to 5 terabytes.

Return custom responses to HTTP requests
Return custom responses to HTTP requests

Return any JSON-serializable response from an HTTP triggered workflow using $respond().

Use most npm packages
Use most npm packages

To use any npm package, just require() it -- there's no npm install or package.json required.

Maintain state between executions
Maintain state between executions

Use $checkpoint to save state in one workflow invocation and read it the next time your workflow runs.

Pass data between steps
Pass data between steps

Return data from any step to inspect it in a human-friendly way and reference the data in future steps via the steps object.