Create Project with Frame.io API on New App Charges from Shopify Partner API

Pipedream makes it easy to connect APIs for Frame.io, Shopify Partner and 2,800+ other apps remarkably fast.

Trigger workflow on

New App Charges from the Shopify Partner API

Next, do this

Create Project with the Frame.io 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 Frame.io 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 Charges trigger
1. Connect your Shopify Partner account
2. Configure timer
3. Optional- Configure createdAtMin
4. Optional- Configure createdAtMin
Configure the Create Project action
1. Connect your Frame.io account
2. Select a Account ID
3. Select a Team ID
4. Optional- Configure Name
5. Optional- Configure Private
6. Optional- Configure Project Preferences
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 Charges on Shopify Partner

Description:Emit new events when new app charges made to your partner account.

Version:0.0.18

Key:shopify_partner-new-app-charges

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

export default {
  key: "shopify_partner-new-app-charges",
  name: "New App Charges",
  type: "source",
  version: "0.0.18",
  description:
    "Emit new events when new app charges made to your partner account.",
  ...common,
  props: {
    ...common.props,
    createdAtMin: {
      type: "string",
      description:
        "Only include transactions after this specific time (ISO timestamp)",
      label: "createdAtMin",
      optional: true,
    },
    createdAtMax: {
      type: "string",
      description:
        "Only include transactions up to this specific time (ISO timestamp)",
      label: "createdAtMin",
      optional: true,
    },
  },
  async run() {
    const {
      createdAtMin, createdAtMax, db,
    } = this;

    const variables = {};
    if (createdAtMin) {
      variables.createdAtMin = createdAtMin.trim();
    }
    if (createdAtMax) {
      variables.createdAtMax = createdAtMax.trim();
    }

    await this.shopify.query({
      db,
      key: "shopify_partner-transactions",
      query: getAppTransactions,
      variables,
      hasNextPagePath: "transactions.pageInfo.hasNextPage",
      getCursor: () => {
        return null;
      },
      handleEmit: (data) => {
        console.log(
          data.transactions.edges.map(({ node: { ...txn } }) => txn.id),
        );

        data.transactions.edges.map(({ node: { ...txn } }) => {
          this.$emit(txn, {
            id: txn.id,
            summary: `Transaction ${txn.id} earned ${txn.netAmount.amount} ${txn.netAmount.currencyCode}`,
          });
        });
      },
    });
  },
};

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
createdAtMin	`createdAtMin`	`string`	Only include transactions after this specific time (ISO timestamp)
createdAtMin	`createdAtMax`	`string`	Only include transactions 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 Project on Frame.io

Description:Creates a new project on Frame.io. [See the documentation](https://developer.frame.io/api/reference/operation/createProject/)

Version:0.0.2

Key:frame-create-project

View on GitHub

Frame.io Overview#

The Frame.io API hooks into their robust video collaboration platform, enabling automated workflows around video reviews, project updates, and asset management. With the API, you can programmatically interact with comments, accounts, projects, and more—perfect for integrating with other tools to streamline video production pipelines.

Action Code#

import frame from "../../frame.app.mjs";
import { parseObjectValues } from "../../common/utils.mjs";

export default {
  key: "frame-create-project",
  name: "Create Project",
  description: "Creates a new project on Frame.io. [See the documentation](https://developer.frame.io/api/reference/operation/createProject/)",
  version: "0.0.2",
  type: "action",
  props: {
    frame,
    accountId: {
      propDefinition: [
        frame,
        "accountId",
      ],
    },
    teamId: {
      propDefinition: [
        frame,
        "teamId",
        ({ accountId }) => ({
          accountId,
        }),
      ],
    },
    name: {
      type: "string",
      label: "Name",
      description: "The name of the project.",
      optional: true,
    },
    private: {
      type: "boolean",
      label: "Private",
      description: "If true, the project is private to the creating user",
      optional: true,
    },
    projectPreferences: {
      type: "object",
      label: "Project Preferences",
      description: "Preferences to set for the project. [See the documentation](https://developer.frame.io/api/reference/operation/createProject/) for valid properties.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.frame.createProject({
      $,
      teamId: this.teamId,
      data: {
        name: this.name,
        private: this.private,
        project_preferences: parseObjectValues(this.projectPreferences),
      },
    });

    $.export("$summary", `Successfully created project (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
Frame.io	`frame`	`app`	This component uses the Frame.io app.
Account ID	`accountId`	`string`	Select a value from the drop down menu.
Team ID	`teamId`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	The name of the project.
Private	`private`	`boolean`	If true, the project is private to the creating user
Project Preferences	`projectPreferences`	`object`	Preferences to set for the project. See the documentation for valid properties.

Action Authentication#

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

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

presentation.updatecomment.readasset.updatereviewlink.updatewebhook.createaccount.readaction.updatereviewlink.readpresentation.readaction.createpresentation.createauditlog.readteam.createcomment.createteam.readofflinereviewlink.deleteproject.updateproject.deletewebhook.deleteaction.deleteasset.deletewebhook.readasset.createcomment.deletewebhook.updateasset.readcomment.updateproject.readaction.readreviewlink.createpresentation.deleteproject.createteam.update