Run Actor with Apify API on New Requests from HTTP / Webhook API

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

Trigger workflow on

New Requests from the HTTP / Webhook API

Next, do this

Run Actor with the Apify 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 HTTP / Webhook trigger and Apify action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Requests trigger
1. Optional- Configure Body Only
2. Optional- Configure Response Status Code
3. Optional- Configure Response Content-Type
4. Optional- Configure Response Body
5. Connect your HTTP / Webhook account
Configure the Run Actor action
1. Connect your Apify account
2. Select a Actor ID
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 Requests on HTTP / Webhook

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

Version:0.1.1

Key:http-new-requests

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.

Trigger Code#

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

// Core HTTP component
export default {
  key: "http-new-requests",
  name: "New Requests",
  description: "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.",
  version: "0.1.1",
  type: "source",
  props: {
    httpInterface: {
      type: "$.interface.http",
      customResponse: true,
    },
    emitBodyOnly: {
      type: "boolean",
      label: "Body Only",
      description: "This source emits an event representing the full HTTP request by default. Select `true` to emit the body only.",
      optional: true,
      default: false,
    },
    resStatusCode: {
      type: "string",
      label: "Response Status Code",
      description: "The status code to return in the HTTP response",
      optional: true,
      default: "200",
    },
    resContentType: {
      type: "string",
      label: "Response Content-Type",
      description: "The `Content-Type` of the body returned in the HTTP response",
      optional: true,
      default: "application/json",
    },
    resBody: {
      type: "string",
      label: "Response Body",
      description: "The body to return in the HTTP response",
      optional: true,
      default: "{ \"success\": true }",
    },
    http,
  },
  async run(event) {
    const summary = `${event.method} ${event.path}`;

    this.httpInterface.respond({
      status: this.resStatusCode,
      body: this.resBody,
      headers: {
        "content-type": this.resContentType,
      },
    });

    if (this.emitBodyOnly) {
      this.$emit(event.body, {
        summary,
      });
    } else {
      this.$emit(event, {
        summary,
      });
    }
  },
};

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
N/A	`httpInterface`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Body Only	`emitBodyOnly`	`boolean`	This source emits an event representing the full HTTP request by default. Select `true` to emit the body only.
Response Status Code	`resStatusCode`	`string`	The status code to return in the HTTP response
Response Content-Type	`resContentType`	`string`	The `Content-Type` of the body returned in the HTTP response
Response Body	`resBody`	`string`	The body to return in the HTTP response
HTTP / Webhook	`http`	`app`	This component uses the HTTP / Webhook app.

Trigger Authentication#

The HTTP / Webhook API does not require authentication.

About HTTP / Webhook#

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

Action#

Run Actor on Apify

Description:Performs an execution of a selected actor in Apify. [See the documentation](https://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor)

Version:0.0.1

Key:apify-run-actor

View on GitHub

Apify Overview#

The Apify API unleashes the power to automate web scraping, process data, and orchestrate web automation workflows. By utilizing Apify on Pipedream, you can create dynamic serverless workflows to manage tasks like extracting data from websites, running browser automation, and scheduling these jobs to run autonomously. It integrates smoothly with Pipedream's capabilities to trigger actions on various other apps, store the results, and manage complex data flow with minimal setup.

Action Code#

/* eslint-disable no-unused-vars */
import apify from "../../apify.app.mjs";

export default {
  key: "apify-run-actor",
  name: "Run Actor",
  description: "Performs an execution of a selected actor in Apify. [See the documentation](https://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor)",
  version: "0.0.1",
  type: "action",
  props: {
    apify,
    actorId: {
      propDefinition: [
        apify,
        "actorId",
      ],
      reloadProps: true,
    },
  },
  methods: {
    getType(type) {
      return [
        "string",
        "object",
        "integer",
        "boolean",
      ].includes(type)
        ? type
        : "string[]";
    },
    async getSchema() {
      const { data: { items: builds } } = await this.apify.listBuilds(this.actorId);
      const buildId = builds.at(-1).id;
      const { data: { inputSchema } } = await this.apify.getBuild(buildId);
      return JSON.parse(inputSchema);
    },
    async prepareData(data) {
      const newData = {};

      const { properties } = await this.getSchema();
      for (const [
        key,
        value,
      ] of Object.entries(data)) {
        const editor = properties[key].editor;
        newData[key] = (Array.isArray(value))
          ? value.map((item) => this.setValue(editor, item))
          : value;
      }
      return newData;
    },
    prepareOptions(value) {
      let options = [];
      if (value.enum && value.enumTitles) {
        for (const [
          index,
          val,
        ] of value.enum.entries()) {
          if (val) {
            options.push({
              value: val,
              label: value.enumTitles[index],
            });
          }
        }
      }
      return options.length
        ? options
        : undefined;
    },
    setValue(editor, item) {
      switch (editor) {
      case "requestListSources" : return {
        url: item,
      };
      case "pseudoUrls" : return {
        purl: item,
      };
      case "globs" : return {
        glob: item,
      };
      default: return item;
      }
    },
  },
  async additionalProps() {
    const props = {};
    if (this.actorId) {
      const {
        properties, required: requiredProps = [],
      } = await this.getSchema();

      for (const [
        key,
        value,
      ] of Object.entries(properties)) {
        if (value.editor === "hidden") continue;

        props[key] = {
          type: this.getType(value.type),
          label: value.title,
          description: value.description,
          optional: !requiredProps.includes(key),
        };
        const options = this.prepareOptions(value);
        if (options) props[key].options = options;
      }
    }
    return props;
  },
  async run({ $ }) {
    const {
      getType,
      getSchema,
      prepareOptions,
      setValue,
      prepareData,
      apify,
      actorId,
      ...data
    } = this;

    const response = await apify.runActor({
      actorId,
      data: await prepareData(data),
    });
    $.export("$summary", `Successfully started actor run with ID: ${response.data.id}`);
    return response;
  },
};

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
Apify	`apify`	`app`	This component uses the Apify app.
Actor ID	`actorId`	`string`	Select a value from the drop down menu.

Action Authentication#

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

You can find your API token on the Integrations page in the Apify console.

About Apify#

Apify is the place to find, develop, buy and run cloud programs called actors. Use actors to turn any website into an API.

More Ways to Connect Apify + HTTP / Webhook#

Other Popular Integrations#

Run Actor with Apify API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Apify