Execute Stored Procedure with MySQL API on New Expense from Oyster API

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

Trigger workflow on

New Expense from the Oyster API

Next, do this

Execute Stored Procedure 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 Oyster 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 Expense trigger
1. Connect your Oyster account
2. Configure timer
Configure the Execute Stored Procedure action
1. Connect your MySQL account
2. Select a Stored Procedure
3. Optional- Configure Parameters
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 Expense on Oyster

Description:Emit new event when a new expense is created in Oyster. [See the documentation](https://docs.oysterhr.com/reference/get_v1-expenses)

Version:0.0.1

Key:oyster-new-expense

View on GitHub

Oyster Overview#

The Oyster API allows you to streamline your global employment processes by providing programmatic access to their HR platform. With it, you can automate tasks like managing employee details, handling payroll, and tracking time off. Pipedream, as a serverless integration platform, makes it simple to create workflows that connect the Oyster API with hundreds of other apps. This can help in automating HR operations, syncing employee data across systems, or even sending notifications when certain HR events occur.

Trigger Code#

import common from "../common/base.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "oyster-new-expense",
  name: "New Expense",
  description: "Emit new event when a new expense is created in Oyster. [See the documentation](https://docs.oysterhr.com/reference/get_v1-expenses)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getTsField() {
      return "submittedAt";
    },
    getResourceFn() {
      return this.oyster.listExpenses;
    },
    generateMeta(expense) {
      return {
        id: expense.expenseId,
        summary: `New Expense ${expense.expenseId}`,
        ts: Date.parse(expense.submittedAt),
      };
    },
  },
  sampleEmit,
};

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
Oyster	`oyster`	`app`	This component uses the Oyster app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

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

About Oyster#

Automated Global Employment Platform

Action#

Execute Stored Procedure on MySQL

Description:Execute Stored Procedure. [See the docs here](https://dev.mysql.com/doc/refman/8.0/en/stored-programs-defining.html)

Version:2.0.5

Key:mysql-execute-stored-procedure

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-stored-procedure",
  name: "Execute Stored Procedure",
  description: "Execute Stored Procedure. [See the docs here](https://dev.mysql.com/doc/refman/8.0/en/stored-programs-defining.html)",
  type: "action",
  version: "2.0.5",
  props: {
    mysql,
    storedProcedure: {
      propDefinition: [
        mysql,
        "storedProcedure",
      ],
    },
    values: {
      propDefinition: [
        mysql,
        "storedProcedureParameters",
      ],
    },
  },
  async run({ $ }) {
    const {
      storedProcedure,
      values,
    } = this;

    const response = await this.mysql.executeStoredProcedure({
      storedProcedure,
      values,
    });

    $.export("$summary", `Successfully executed stored procedure ${storedProcedure}`);

    const result =
      Array.isArray(response)
        ? response[0]
        : response;

    return result || {
      success: false,
    };
  },
};

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.
Stored Procedure	`storedProcedure`	`string`	Select a value from the drop down menu.
Parameters	`values`	`string[]`	Parameters for the stored procedure

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.