Create Proxy Session with Oxylabs API on New Contact from Mautic API

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

Trigger workflow on

New Contact from the Mautic 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 Mautic 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 Contact trigger
1. Connect your Mautic account
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 Contact on Mautic

Description:Emit new event when a contact is created. [See the docs](https://developer.mautic.org/#webhooks)

Version:0.0.1

Key:mautic-new-contact

View on GitHub

Mautic Overview#

The Mautic API empowers marketers to automate and integrate a wide range of marketing tasks directly into Pipedream workflows. With Mautic's API, you can manage contacts, campaigns, emails, and reports, and use triggers to automate responses based on user behavior. It's a robust tool to align marketing efforts with real-time data and actions, making it possible to personalize communication, streamline follow-ups, and ultimately drive conversions with less manual effort.

Trigger Code#

import base from "../common/base.mjs";
import constants from "../common/constants.mjs";

export default {
  ...base,
  key: "mautic-new-contact",
  name: "New Contact",
  description: "Emit new event when a contact is created. [See the docs](https://developer.mautic.org/#webhooks)",
  version: "0.0.1",
  type: "source",
  methods: {
    ...base.methods,
    getEventType() {
      return constants.EVENT_TYPES.CONTACT_CREATED;
    },
    getEventListFn() {
      return {
        fn: this.mautic.listContacts,
      };
    },
    isRelevant() {
      return true;
    },
    generateMeta(contact) {
      const name = `${contact.fields.core.firstname.value} ${contact.fields.core.lastname.value}`;
      const summary = `New contact: ${name}`;
      const {
        id,
        dateAdded: ts,
      } = contact;
      return {
        id,
        ts,
        summary,
      };
    },
    emitEvent(event) {
      const contact = event.contact
        ? event.contact
        : event;
      const meta = this.generateMeta(contact);
      console.log(`Emitting event - ${meta.summary}`);
      this.$emit(contact, 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
Mautic	`mautic`	`app`	This component uses the Mautic 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.

Trigger Authentication#

Mautic uses OAuth authentication. When you connect your Mautic account, Pipedream will open a popup window where you can sign into Mautic and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Mautic API.

Pipedream requests the following authorization scopes when you connect your account:

About Mautic#

Open Source Marketing Automation

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.