Create Event with Heartbeat API on New Column from MySQL API

Pipedream makes it easy to connect APIs for Heartbeat, MySQL and 3,000+ other apps remarkably fast.

Trigger workflow on

New Column from the MySQL API

Next, do this

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

Select this integration
Configure the New Column trigger
1. Connect your MySQL account
2. Configure timer
3. Select a Table
Configure the Create Event action
1. Connect your Heartbeat account
2. Configure Name
3. Optional- Configure Description
4. Configure Start Date & Time
5. Configure Duration
6. Select a Location
7. Optional- Select one or more Invited Users
8. Optional- Select one or more Invited Groups
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 Column on MySQL

Description:Emit new event when you add a new column to a table. [See the docs here](https://dev.mysql.com/doc/refman/8.0/en/show-columns.html)

Version:2.0.6

Key:mysql-new-column

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";

export default {
  ...common,
  key: "mysql-new-column",
  name: "New Column",
  description:
    "Emit new event when you add a new column to a table. [See the docs here](https://dev.mysql.com/doc/refman/8.0/en/show-columns.html)",
  type: "source",
  version: "2.0.6",
  dedupe: "unique",
  props: {
    ...common.props,
    db: "$.service.db",
  },
  methods: {
    ...common.methods,
    _getPreviousColumns() {
      return this.db.get("previousColumns");
    },
    _setPreviousColumns(previousColumns) {
      this.db.set("previousColumns", previousColumns);
    },
    async listResults() {
      const { table } = this;
      let previousColumns = this._getPreviousColumns() || [];
      const columns = await this.mysql.listNewColumns({
        table,
        previousColumns,
      });
      this.iterateAndEmitEvents(columns);

      const newColumnNames = columns
        .map((column) => column.Field)
        .filter((c) => !previousColumns.includes(c));

      previousColumns = previousColumns.concat(newColumnNames);
      this._setPreviousColumns(previousColumns);
    },
    generateMeta(column) {
      const columnName = column.Field;
      return {
        id: `${columnName}${this.table}`,
        summary: columnName,
        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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

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#

Create Event on Heartbeat

Description:Create a new Event in a Heartbeat community. [See the documentation](https://heartbeat.readme.io/reference/createevent)

Version:0.0.1

Key:heartbeat-create-event

View on GitHub

Heartbeat Overview#

The Heartbeat API offers a powerful way to connect and automate your community engagement. With this API, you can monitor community signals, manage members, and trigger events based on community interactions. By integrating Heartbeat with Pipedream, you can create dynamic, serverless workflows that act upon these signals and bring efficiency to your community management tasks. Whether it's automating welcome messages, syncing member data with other platforms, or analyzing community health, the possibilities are vast.

Action Code#

import { parseObject } from "../../common/utils.mjs";
import heartbeat from "../../heartbeat.app.mjs";

export default {
  key: "heartbeat-create-event",
  name: "Create Event",
  description: "Create a new Event in a Heartbeat community. [See the documentation](https://heartbeat.readme.io/reference/createevent)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    heartbeat,
    name: {
      type: "string",
      label: "Name",
      description: "The name of the event",
    },
    description: {
      type: "string",
      label: "Description",
      description: "The description of the event",
      optional: true,
    },
    startTime: {
      type: "string",
      label: "Start Date & Time",
      description: "The start date & time of the event. Accepts datetimes in the following formats: `YYYY-MM-DD hh:mm:ss` e.g. 2023-11-28 10:00:00, `YYYY-MM-DD hh:mm` e.g. 2023-11-28 10:00, `YYYY-MM-DD` e.g. 2023-11-28",
    },
    duration: {
      type: "integer",
      label: "Duration",
      description: "The duration of the event in minutes",
    },
    location: {
      type: "string",
      label: "Location",
      description: "Where the event will be held. If the string 'HEARTBEAT' is provided, then the event will take place in a Heartbeat voice channel. If the string 'ZOOM' is provided, then the event will take place in a custom Zoom link (this option can only be chosen if a Zoom account has been integrated with Heartbeat). Otherwise, the provided string will be passed directly to the Custom location field",
      options: [
        "HEARTBEAT",
        "ZOOM",
      ],
    },
    invitedUsers: {
      propDefinition: [
        heartbeat,
        "emails",
      ],
      type: "string[]",
      label: "Invited Users",
      description: "A list of users that should be invited to the event. If the email matches an existing Heartbeat user, the Heartbeat user will be invited. Otherwise, an event invite will be sent directly to the provided email address. If both `Invited Users` & `Invited Groups` are empty, the event will be open to everyone in the community",
      optional: true,
    },
    invitedGroups: {
      propDefinition: [
        heartbeat,
        "groupID",
      ],
      type: "string[]",
      label: "Invited Groups",
      description: "A list of groups that should be invited to the event. If both `Invited Users` and `Invited Groups` are empty, the event will be open to everyone in the community",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.heartbeat.createEvent({
      $,
      data: {
        name: this.name,
        description: this.description,
        startTime: this.startTime,
        duration: this.duration,
        location: this.location,
        invitedUsers: parseObject(this.invitedUsers),
        invitedGroups: parseObject(this.invitedGroups),
      },
    });

    $.export("$summary", `Successfully created event with ID ${response.event.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
Heartbeat	`heartbeat`	`app`	This component uses the Heartbeat app.
Name	`name`	`string`	The name of the event
Description	`description`	`string`	The description of the event
Start Date & Time	`startTime`	`string`	The start date & time of the event. Accepts datetimes in the following formats: `YYYY-MM-DD hh:mm:ss` e.g. 2023-11-28 10:00:00, `YYYY-MM-DD hh:mm` e.g. 2023-11-28 10:00, `YYYY-MM-DD` e.g. 2023-11-28
Duration	`duration`	`integer`	The duration of the event in minutes
Location	`location`	`string`	Select a value from the drop down menu:`HEARTBEATZOOM`
Invited Users	`invitedUsers`	`string[]`	Select a value from the drop down menu.
Invited Groups	`invitedGroups`	`string[]`	Select a value from the drop down menu.

Action Authentication#

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

To retrieve your API credentials,

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