Add Contact to Campaign with Overloop API on New Row (Custom Query) from MySQL API

Pipedream makes it easy to connect APIs for Overloop, MySQL and 2,400+ other apps remarkably fast.

Trigger workflow on

New Row (Custom Query) from the MySQL API

Next, do this

Add Contact to Campaign with the Overloop 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 MySQL trigger and Overloop action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Row (Custom Query) trigger
1. Connect your MySQL account
2. Configure timer
3. Select a Table
4. Optional- Select a De-duplication Key
5. Configure Where condition
6. Configure Values
Configure the Add Contact to Campaign action
1. Connect your Overloop account
2. Select a Contact ID
3. Select a Campaign 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 Row (Custom Query) on MySQL

Description:Emit new event when new rows are returned from a custom query. [See the docs here](https://dev.mysql.com/doc/refman/8.0/en/select.html)

Version:2.0.5

Key:mysql-new-row-custom-query

View on GitHub

MySQL Overview#

The MySQL application on Pipedream enables direct interaction with your MySQL databases, allowing you to perform CRUD operations—create, read, update, delete—on your data with ease. You can leverage these capabilities to automate data synchronization, report generation, and event-based triggers that kick off workflows in other apps. With Pipedream's serverless platform, you can connect MySQL to hundreds of other services without managing infrastructure, crafting complex code, or handling authentication.

Trigger Code#

import common from "../common/table.mjs";
import { v4 as uuidv4 } from "uuid";

const { mysql } = common.props;

export default {
  ...common,
  key: "mysql-new-row-custom-query",
  name: "New Row (Custom Query)",
  description: "Emit new event when new rows are returned from a custom query. [See the docs here](https://dev.mysql.com/doc/refman/8.0/en/select.html)",
  version: "2.0.5",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    column: {
      propDefinition: [
        mysql,
        "column",
        (c) => ({
          table: c.table,
        }),
      ],
      label: "De-duplication Key",
      description:
        "The name of a column in the table to use for de-duplication",
      optional: true,
    },
    condition: {
      propDefinition: [
        mysql,
        "whereCondition",
      ],
    },
    values: {
      propDefinition: [
        mysql,
        "whereValues",
      ],
    },
  },
  methods: {
    ...common.methods,
    async listResults() {
      const {
        table,
        condition,
        values,
      } = this;

      const numberOfQuestionMarks = condition?.match(/\?/g)?.length;

      if (!numberOfQuestionMarks) {
        throw new Error("No valid condition provided. At least one question mark character ? must be provided.");
      }

      if (!Array.isArray(values)) {
        throw new Error("No valid values provided. The values property must be an array.");
      }

      if (values.length !== numberOfQuestionMarks) {
        throw new Error("The number of values provided does not match the number of question marks ? in the condition.");
      }

      const rows = await this.mysql.findRows({
        table,
        condition,
        values,
      });
      this.iterateAndEmitEvents(rows);
    },
    generateMeta(row) {
      const id = this.column
        ? row[this.column]
        : uuidv4();
      return {
        id,
        summary: `New Row ${id}`,
        ts: Date.now(),
      };
    },
  },
};

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
MySQL	`mysql`	`app`	This component uses the MySQL app.
	`timer`	`$.interface.timer`
Table	`table`	`string`	Select a value from the drop down menu.
De-duplication Key	`column`	`string`	Select a value from the drop down menu.
Where condition	`condition`	`string`	In this expression you can write your own conditions (eg. `column1 = ? or column2 = ?`). Depending on the number of `?` symbols likewise you need to add the same number of values.
Values	`values`	`string[]`	This is the list of values that will match every `?` symbol in the where expression. If you want to build yourself the values (eg. `{{["string1", "string2"]}}`)

Trigger Authentication#

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

Connecting to Restricted Databases

Either enable the shared static IP for this account below, or configure a VPC to deploy any workflow in your workspace to a private network with a dedicated static IP. Learn more in our docs.

SSL Setup

Configure SSL on your MySQL database by providing the CA (Certificate Authority), and choosing between Full Verification, Verify Certificate Authority (CA), or Skip Verification. Skipping verification is not recommended as this has serious security implications.

About MySQL#

MySQL is an open-source relational database management system.

Action#

Add Contact to Campaign on Overloop

Description:Adds a contact to a campaign. [See the docs](https://apidoc.overloop.com/#enrollments)

Version:0.0.1

Key:overloop-add-contact-to-campaign

View on GitHub

Overloop Overview#

The Overloop API is a powerhouse for sales automation, enabling users to streamline their sales pipeline by automating repetitive tasks, syncing data across platforms, and enhancing lead management. With Pipedream, you can leverage Overloop's capabilities to create detailed, event-driven workflows that respond in real-time to changes in your sales environment. This integration can help maintain a healthy sales funnel, ensure timely follow-ups, and personalize communication at scale.

Action Code#

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

export default {
  key: "overloop-add-contact-to-campaign",
  name: "Add Contact to Campaign",
  description: "Adds a contact to a campaign. [See the docs](https://apidoc.overloop.com/#enrollments)",
  version: "0.0.1",
  type: "action",
  props: {
    overloop,
    contactId: {
      propDefinition: [
        overloop,
        "contactId",
      ],
    },
    campaignId: {
      propDefinition: [
        overloop,
        "automationId",
        () => ({
          type: "campaign",
          status: "on",
        }),
      ],
    },
  },
  async run({ $ }) {
    const data = {
      data: {
        type: "enrollments",
        attributes: {
          contact_id: this.contactId,
        },
      },
    };

    const { data: response } = await this.overloop.createEnrollment(this.campaignId, {
      data,
      $,
    });

    $.export("$summary", `Contact with ID ${this.contactId} added to campaign with ID ${this.campaignId}.`);

    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
Overloop	`overloop`	`app`	This component uses the Overloop app.
Contact ID	`contactId`	`string`	Select a value from the drop down menu.
Campaign ID	`campaignId`	`string`	Select a value from the drop down menu.

Action Authentication#

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

To retrieve your API key,

Navigate to your Overloop account and sign in
Go to “Settings” > “API”