Create Proxy Session with Oxylabs API on New Event Received (Instant) from Hookdeck API

Pipedream makes it easy to connect APIs for Oxylabs, Hookdeck and 2,700+ other apps remarkably fast.

Trigger workflow on

New Event Received (Instant) from the Hookdeck API

Next, do this

Create Proxy Session with the Oxylabs 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 Hookdeck trigger and Oxylabs action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Event Received (Instant) trigger
1. Connect your Hookdeck account
2. Optional- Configure Connection Name
3. Optional- Configure Description
4. Optional- Select a Pre-exisiting Source
5. Optional- Configure New Source
6. Optional- Configure Destination Name
Configure the Create Proxy Session action
1. Connect your Oxylabs account
2. Configure Username
3. Configure Password
4. Configure Session ID
5. Optional- Configure Country Code
6. Optional- Configure City
7. Optional- Configure State
8. Optional- Configure Session Time
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 Event Received (Instant) on Hookdeck

Description:Emit new event when a new event is received from a HookDeck source.

Version:0.0.2

Key:hookdeck-new-event-received

View on GitHub

Hookdeck Overview#

The Hookdeck API facilitates the management of webhooks, providing reliable webhook delivery, monitoring, and debugging solutions. With this API on Pipedream, you can automate workflows concerning incoming webhook data—transforming, routing, and ensuring they trigger the subsequent actions without fail. This could range from logging data for analysis, conditionally processing and forwarding webhook events to other endpoints, or integrating with third-party services for extended automation.

Trigger Code#

import app from "../../hookdeck.app.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "hookdeck-new-event-received",
  name: "New Event Received (Instant)",
  description: "Emit new event when a new event is received from a HookDeck source.",
  version: "0.0.2",
  type: "source",
  dedupe: "unique",
  props: {
    app,
    db: "$.service.db",
    http: "$.interface.http",
    name: {
      type: "string",
      label: "Connection Name",
      description: "The name of the connection.",
      optional: true,
    },
    description: {
      type: "string",
      label: "Description",
      description: "The description of the connection.",
      optional: true,
    },
    sourceId: {
      propDefinition: [
        app,
        "sourceId",
      ],
      label: "Pre-exisiting Source",
    },
    source: {
      type: "object",
      label: "New Source",
      description: "An object representing the source of the connection. Object must contain at least `name`. Please check the [documentation](https://hookdeck.com/api-ref#create-a-connection) for more information.",
      default: {
        name: "My New Source",
      },
      optional: true,
    },
    destinationName: {
      type: "string",
      label: "Destination Name",
      description: "The destination name that will be created or updated with Pipedream HTTP endpoint for Pipedream source to receive your event. Existing destination with the same name will be overridden with the new HTTP endpoint",
      optional: true,
    },
  },
  hooks: {
    async deploy() {
      if (this.sourceId && this.source) {
        throw new ConfigurationError("Only one of `Source Id` or `Source` may be provided.");
      }
      if (!this.source && !this.sourceId) {
        throw new ConfigurationError("Either `Source Id` or `Source` must be provided.");
      }
    },
    async activate() {
      const { id } = await this.app.createConnection({
        name: this.name || `Pipedream_Connection_${this.getCurrentDateTime()}`,
        description: this.description,
        source_id: this.sourceId,
        source: this.source,
        destination: {
          name: this.destinationName || `Pipedream_Source_${this.getCurrentDateTime()}`,
          url: this.http.endpoint,
        },
      });
      this._setHookId(id);
    },
    async deactivate() {
      const id = this._getHookId();
      if (id) {
        await this.deleteConnection(id);
      }
    },
  },
  methods: {
    _getHookId() {
      return this.db.get("hookId");
    },
    _setHookId(hookId) {
      this.db.set("hookId", hookId);
    },
    async deleteConnection(id) {
      await this.app._makeHttpRequest({
        method: "DELETE",
        path: `/connections/${id}`,
      });
    },
    getCurrentDateTime() {
      const now = new Date();
      const year = now.getFullYear();
      const month = (now.getMonth() + 1).toString().padStart(2, "0");
      const day = now.getDate().toString()
        .padStart(2, "0");
      const hours = now.getHours().toString()
        .padStart(2, "0");
      const minutes = now.getMinutes().toString()
        .padStart(2, "0");

      return `${year}${month}${day}${hours}${minutes}`;
    },
    generateMeta() {
      return {
        id: Date.now(),
        summary: "New Event Received",
        ts: Date.now(),
      };
    },
  },
  async run(event) {
    const { body } = event;
    const meta = this.generateMeta();
    this.$emit(body, meta);
  },
};

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
Hookdeck	`app`	`app`	This component uses the Hookdeck app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.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.
Connection Name	`name`	`string`	The name of the connection.
Description	`description`	`string`	The description of the connection.
Pre-exisiting Source	`sourceId`	`string`	Select a value from the drop down menu.
New Source	`source`	`object`	An object representing the source of the connection. Object must contain at least `name`. Please check the documentation for more information.
Destination Name	`destinationName`	`string`	The destination name that will be created or updated with Pipedream HTTP endpoint for Pipedream source to receive your event. Existing destination with the same name will be overridden with the new HTTP endpoint

Trigger Authentication#

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

About Hookdeck#

Never miss a webhook again. Our reliable webhook infrastructure gives you full visibility over your webhooks.

Action#

Create Proxy Session on Oxylabs

Description:Establish a proxy session using the Residential Proxy endpoint. [See the documentation](https://developers.oxylabs.io/proxies/residential-proxies/session-control#establishing-session)

Version:0.0.1

Key:oxylabs-create-proxy-session

View on GitHub

Oxylabs Overview#

The Oxylabs API provides robust tools for web data extraction, enabling you to gather vast amounts of data efficiently from various sources across the web. With Pipedream's serverless platform, you can harness this power to create automated workflows that trigger on specific events, process the data, and connect to other services. Whether you're monitoring brand sentiment, tracking prices, or conducting market research, integrating Oxylabs with Pipedream can significantly streamline your data collection and analysis tasks.

Action Code#

import oxylabs from "../../oxylabs.app.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "oxylabs-create-proxy-session",
  name: "Create Proxy Session",
  description: "Establish a proxy session using the Residential Proxy endpoint. [See the documentation](https://developers.oxylabs.io/proxies/residential-proxies/session-control#establishing-session)",
  version: "0.0.1",
  type: "action",
  props: {
    oxylabs,
    username: {
      type: "string",
      label: "Username",
      description: "The username for the proxy user",
    },
    password: {
      type: "string",
      label: "Password",
      description: "The password for the proxy user",
    },
    sessid: {
      type: "string",
      label: "Session ID",
      description: "Session ID to keep the same IP with upcoming queries. The session expires in 10 minutes. After that, a new IP address is assigned to that session ID. Random string, 0-9, and A-Z characters are supported.",
    },
    cc: {
      type: "string",
      label: "Country Code",
      description: "Case insensitive country code in 2-letter [3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)",
      optional: true,
    },
    city: {
      type: "string",
      label: "City",
      description: "Case insensitive city name in English. This parameter must be accompanied by cc for better accuracy.",
      optional: true,
    },
    st: {
      type: "string",
      label: "State",
      description: "Case insensitive US state name with us_ in the beginning, for example, `us_california`, `us_illinois`",
      optional: true,
    },
    sstime: {
      type: "string",
      label: "Session Time",
      description: "Session time in minutes. The session time parameter keeps the same IP for a certain period. The maximum session time is 30 minutes.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      username,
      password,
      sessid,
      cc,
      city,
      st,
      sstime,
    } = this;

    if (city && !cc) {
      throw new ConfigurationError("City must be accompanied by country code");
    }

    const proxyUrl = `http://customer-${username}${cc
      ? `-cc-${cc}`
      : ""}${city
      ? `-city-${city}`
      : ""}${st
      ? `-st-${st}`
      : ""}${sessid
      ? `-sessid-${sessid}`
      : ""}${sstime
      ? `-sstime-${sstime}`
      : ""}:${password}@pr.oxylabs.io:7777`;
    const response = await this.oxylabs.createSession({
      $,
      proxyUrl,
    });
    $.export("$summary", `Successfully created proxy session with session ID: ${this.sessid}`);
    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
Oxylabs	`oxylabs`	`app`	This component uses the Oxylabs app.
Username	`username`	`string`	The username for the proxy user
Password	`password`	`string`	The password for the proxy user
Session ID	`sessid`	`string`	Session ID to keep the same IP with upcoming queries. The session expires in 10 minutes. After that, a new IP address is assigned to that session ID. Random string, 0-9, and A-Z characters are supported.
Country Code	`cc`	`string`	Case insensitive country code in 2-letter 3166-1 alpha-2 format
City	`city`	`string`	Case insensitive city name in English. This parameter must be accompanied by cc for better accuracy.
State	`st`	`string`	Case insensitive US state name with us_ in the beginning, for example, `us_california`, `us_illinois`
Session Time	`sstime`	`string`	Session time in minutes. The session time parameter keeps the same IP for a certain period. The maximum session time is 30 minutes.