Execute SQL Query with MySQL API on New Event from Superdocu API

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

Trigger workflow on

New Event from the Superdocu API

Next, do this

Execute SQL Query with the MySQL 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 Superdocu trigger and MySQL 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 trigger
1. Connect your Superdocu account
2. Configure Secret
Configure the Execute SQL Query action
1. Connect your MySQL account
2. Configure SQL Query
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 on Superdocu

Description:Emit new events from Superdocu. You can configure your webhook [here](https://www.superdocu.com/en/c/settings/api)

Version:0.0.1

Key:superdocu-new-event

View on GitHub

Superdocu Overview#

The Superdocu API empowers users to automate document collection and management processes, streamlining the way businesses handle paperwork for clients and employees. It facilitates the creation of document requests, tracking of submissions, and management of user data, all programmatically. Leveraging the Superdocu API on Pipedream allows users to build powerful, serverless workflows that can interact with a broad array of other applications, improving efficiency, reducing manual labor, and ensuring critical documents are collected and processed on time.

Trigger Code#

import crypto from "crypto";
import app from "../../superdocu.app.mjs";

export default {
  type: "source",
  key: "superdocu-new-event",
  name: "New Event",
  description: "Emit new events from Superdocu. You can configure your webhook [here](https://www.superdocu.com/en/c/settings/api)",
  version: "0.0.1",
  props: {
    app,
    secret: {
      type: "string",
      label: "Secret",
      description: "The secret used to sign the webhook. [Click here](https://developers.superdocu.com/webhooks) for more information.",
    },
    http: "$.interface.http",
  },
  methods: {
    _checkSignature(timestamp, signature) {
      const plain = `${this.secret}${timestamp}`;
      const shasum = crypto.createHash("sha256").update(plain);
      const signatureComputed = shasum.digest("base64");
      if (signature !== signatureComputed) {
        throw new Error("Invalid signature. Event aborted.");
      }
    },
    _checkReplayAttack(t) {
      const fiveMinutes = 5 * 60 * 1000;
      const tolerance = fiveMinutes;
      const timestampMilliseconds = Number(t) * 1000;

      if (timestampMilliseconds < Date.now() - tolerance) {
        throw new Error("Invalid Timestamp Signature. The signature's timestamp is outside of the tolerance zone. Event aborted");
      }
    },
    _emit(event) {
      this.$emit(event, {
        id: `${event.object_id}${event.event}`,
        summary: `${event.event} - ${event.object_id}`,
        ts: event.fired_at,
      });
    },
  },
  async run(event) {
    this._checkSignature(event.headers["x-hub-timestamp"], event.headers["x-hub-signature"]);
    this._checkReplayAttack(event.headers["x-hub-timestamp"]);
    this._emit(event.body);
  },
};

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
Superdocu	`app`	`app`	This component uses the Superdocu app.
Secret	`secret`	`string`	The secret used to sign the webhook. Click here for more information.
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#

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

To retrieve your API key,

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

About Superdocu#

Superdocu helps companies collect documents from their contacts: clients, employees or partners.

Action#

Execute SQL Query on MySQL

Description:Execute a custom MySQL query. See [our docs](https://pipedream.com/docs/databases/working-with-sql) to learn more about working with SQL in Pipedream.

Version:2.0.1

Key:mysql-execute-raw-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.

Action Code#

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

export default {
  key: "mysql-execute-raw-query",
  name: "Execute SQL Query",
  description: "Execute a custom MySQL query. See [our docs](https://pipedream.com/docs/databases/working-with-sql) to learn more about working with SQL in Pipedream.",
  type: "action",
  version: "2.0.1",
  props: {
    mysql,
    // eslint-disable-next-line pipedream/props-description
    sql: {
      type: "sql",
      auth: {
        app: "mysql",
      },
      label: "SQL Query",
    },
  },
  async run({ $ }) {
    const args = this.mysql.executeQueryAdapter(this.sql);
    const data = await this.mysql.executeQuery(args);
    $.export("$summary", `Returned ${data.length} ${data.length === 1
      ? "row"
      : "rows"}`);
    return data;
  },
};

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
MySQL	`mysql`	`app`	This component uses the MySQL app.
SQL Query	`sql`	`sql`

Action 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.