Create Comment with Airtable API on New App Installs from Shopify Partner API

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

Trigger workflow on

New App Installs from the Shopify Partner API

Next, do this

Create Comment with the Airtable 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 Airtable 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 Installs trigger
1. Connect your Shopify Partner account
2. Configure timer
3. Configure Shopify App ID
4. Optional- Configure occurredAtMin
5. Optional- Configure occurredAtMax
Configure the Create Comment action
1. Connect your Airtable account
2. Select a Base
3. Select a Table
4. Select a Record ID
5. Configure Comment
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 Installs on Shopify Partner

Description:Emit new events when new shops install your app.

Version:0.1.3

Key:shopify_partner-new-app-installs

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 getAppInstalls from "../../common/queries/getAppInstalls.mjs";

export default {
  key: "shopify_partner-new-app-installs",
  name: "New App Installs",
  type: "source",
  version: "0.1.3",
  description: "Emit new events when new shops install your app.",
  ...common,
  props: {
    ...common.props,
    db: "$.service.db",
    appId: {
      propDefinition: [
        shopify,
        "appId",
      ],
    },
    occurredAtMin: {
      propDefinition: [
        shopify,
        "occurredAtMin",
      ],
    },
    occurredAtMax: {
      propDefinition: [
        shopify,
        "occurredAtMax",
      ],
    },
  },
  async run() {
    const {
      appId, occurredAtMin, occurredAtMax, db,
    } = this;

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

    await this.shopify.query({
      db,
      key: "shopify_partner-installs",
      query: getAppInstalls,
      variables,
      handleEmit: (data) => {
        if (data?.app?.events) {
          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?.transactions?.edges || [];
        const [
          last,
        ] = edges.reverse();
        return last?.cursor;
      },
      hasNextPagePath: "app.events.pageInfo.hasNextPage",
    });
  },
};

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)

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#

Create Comment on Airtable

Description:Create a new comment on a record. [See the documentation](https://airtable.com/developers/web/api/create-comment)

Version:0.0.6

Key:airtable_oauth-create-comment

View on GitHub

Airtable Overview#

Airtable (OAuth) API on Pipedream allows you to manipulate and leverage your Airtable data in a myriad of powerful ways. Sync data between Airtable and other apps, trigger workflows on updates, or process bulk data operations asynchronously. By using Airtable's structured databases with Pipedream's serverless platform, you can craft custom automation solutions, integrate with other services seamlessly, and streamline complex data processes.

Action Code#

import common from "../common/common.mjs";

export default {
  key: "airtable_oauth-create-comment",
  name: "Create Comment",
  description: "Create a new comment on a record. [See the documentation](https://airtable.com/developers/web/api/create-comment)",
  version: "0.0.6",
  type: "action",
  props: {
    ...common.props,
    recordId: {
      propDefinition: [
        common.props.airtable,
        "recordId",
        ({
          baseId, tableId,
        }) => ({
          baseId: baseId.value,
          tableId: tableId.value,
        }),
      ],
    },
    comment: {
      type: "string",
      label: "Comment",
      description: "The text comment",
    },
  },
  async run({ $ }) {
    const response = await this.airtable.createComment({
      baseId: this.baseId.value,
      tableId: this.tableId.value,
      recordId: this.recordId,
      data: {
        text: this.comment,
      },
      $,
    });

    if (response) {
      $.export("$summary", `Successfully created comment with ID ${response.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
Airtable	`airtable`	`app`	This component uses the Airtable app.
Base	`baseId`	`string`	Select a value from the drop down menu.
Table	`tableId`	`string`	Select a value from the drop down menu.
Record ID	`recordId`	`string`	Select a value from the drop down menu.
Comment	`comment`	`string`	The text comment

Action Authentication#

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

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

data.records:readdata.records:writedata.recordComments:readdata.recordComments:writeschema.bases:readschema.bases:writewebhook:manageuser.email:read

About Airtable#

Airtable is a low-code platform to build next-gen apps. Move beyond rigid tools, operationalize your critical data, and reimagine workflows with AI.

More Ways to Connect Airtable + Shopify Partner#

Other Popular Integrations#

Create Multiple Records with Airtable API on New App Charges from Shopify Partner API

Shopify Partner + Airtable