Execute SQL Query with MySQL API on New App Relationship Events from Shopify Partner API

Pipedream makes it easy to connect APIs for MySQL, Shopify Partner and 2,900+ other apps remarkably fast.

Trigger workflow on

New App Relationship Events from the Shopify Partner 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 Shopify Partner 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 App Relationship Events trigger
1. Connect your Shopify Partner account
2. Configure timer
3. Configure Shopify App ID
4. Optional- Configure occurredAtMin
5. Optional- Configure occurredAtMax
6. Optional- Configure Maximum records to query per run
7. Select a Pagination direction
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 App Relationship Events on Shopify Partner

Description:Emit new events when new shops installs, uninstalls, subscribes or unsubscribes your app.

Version:0.1.4

Key:shopify_partner-new-app-relationship-events

View on GitHub

Shopify Partner Overview#

The Shopify Partner API lets you tap into a comprehensive suite of features to manage and analyze multiple Shopify stores. You can automate tasks like creating development stores, adding collaborators, tracking payouts, and more. This API serves as a powerful tool for developers, agencies, and freelancers who manage multiple Shopify shops for their clients. Through Pipedream, you can effortlessly integrate Shopify Partner API with other services to create tailored, efficient workflows that save time and enhance productivity.

Trigger Code#

import common from "../../common/common.mjs";
import shopify from "../../shopify_partner.app.mjs";
import getAppRelationshipEventsBackwards from "../../common/queries/getAppRelationshipEventsBackwards.mjs";
import getAppRelationshipEventsForwards from "../../common/queries/getAppRelationshipEventsForwards.mjs";

export default {
  key: "shopify_partner-new-app-relationship-events",
  name: "New App Relationship Events",
  type: "source",
  version: "0.1.4",
  description:
    "Emit new events when new shops installs, uninstalls, subscribes or unsubscribes your app.",
  ...common,
  props: {
    ...common.props,
    db: "$.service.db",
    appId: {
      propDefinition: [
        shopify,
        "appId",
      ],
    },
    occurredAtMin: {
      propDefinition: [
        shopify,
        "occurredAtMin",
      ],
    },
    occurredAtMax: {
      propDefinition: [
        shopify,
        "occurredAtMax",
      ],
    },
    recordsPerRun: {
      propDefinition: [
        shopify,
        "recordsPerRun",
      ],
    },
    paginationDirection: {
      propDefinition: [
        shopify,
        "paginationDirection",
      ],
    },
  },
  async run() {
    const {
      appId,
      occurredAtMin,
      occurredAtMax,
      db,
      paginationDirection,
      recordsPerRun,
    } = this;

    const variables = {
      appId: `gid://partners/App/${appId}`,
    };
    if (occurredAtMin) {
      variables.occurredAtMin = occurredAtMin.trim();
    }
    if (occurredAtMax) {
      variables.occurredAtMax = occurredAtMax.trim();
    }

    console.log("Querying events");

    await this.shopify.query({
      db,
      key: "shopify_partner-relationship-events",
      query:
        this.paginationDirection === "backward" ||
        !this.db.get("shopify_partner-relationship-events") // on the first run, pull records from present day
          ? getAppRelationshipEventsBackwards
          : getAppRelationshipEventsForwards,
      variables,
      handleEmit: (data) => {
        data.app.events.edges.map(({ node: { ...event } }) => {
          this.$emit(event, {
            id: event.occurredAt,
            summary: `${event.shop.name} (${event.shop.myshopifyDomain}) installed ${event.app.name}`,
          });
        });
      },
      getCursor: (data) => {
        const edges = data?.app?.events?.edges || [];
        if (this.paginationDirection === "backward") {
          const last = edges[edges.length - 1];
          console.log("Last event in batch: ", last);
          return last?.cursor;
        } else {
          const [
            first,
          ] = edges;
          console.log("First event in batch: ", first);
          return first?.cursor;
        }
      },
      hasNextPagePath:
        this.paginationDirection === "forward" ||
        !this.db.get("shopify_partner-relationship-events")
          ? "app.events.pageInfo.hasNextPage"
          : "app.events.pageInfo.hasPreviousPage",
      paginationDirection,
      recordsPerRun,
    });
  },
};

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
Shopify Partner	`shopify`	`app`	This component uses the Shopify Partner app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
timer	`timer`	`$.interface.timer`	API Polling Frequency
Shopify App ID	`appId`	`string`	Open your app in the partner portal, and look at the URL to find its ID. If your URL is https://partners.shopify.com/3027494/apps/51358007297/overview, enter `51358007297` here.
occurredAtMin	`occurredAtMin`	`string`	Only include events after this specific time (ISO timestamp)
occurredAtMax	`occurredAtMax`	`string`	Only include events up to this specific time (ISO timestamp)
Maximum records to query per run	`recordsPerRun`	`integer`	Number of records to retrieve per run
Pagination direction	`paginationDirection`	`string`	Select a value from the drop down menu:`{ "label": "Forwards", "value": "forward" }{ "label": "Backwards", "value": "backward" }`

Trigger Authentication#

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

Create an API Key

In order to authorize Pipedream to access your Shopify Partner Account, you will need to generate a new API key for Pipedream to use on your behalf.

First, create an API client in your Shopify Partner account

Make sure to include these scopes:

View financials
Manage apps

You will use this API key to authenticate your Pipedream workflows with Shopify Partners.

Open API key management in the Shopify Partner Portal

Create a new API key

Create API key

Enter in "Pipedream" as the name and select the appropriate scopes, then click "Save" to finish

Enter in Pipedream API key options

Find your Organization ID

After you log into the Shopify Partner portal, look at the URL for your organization ID

Find your Shopify Partner Organization ID

Find your App ID

After opening your app in the partner portal, look in the URL to find it's ID:

Find your Shopify App ID

About Shopify Partner#

Shopify Partner API connection. Listen to events like installs, uninstalls, charges & transactions.

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

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.3",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  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