Create Caption Order Using External Link with Rev API on New App Charges from Shopify Partner API

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

Trigger workflow on

New App Charges from the Shopify Partner API

Next, do this

Create Caption Order Using External Link with the Rev 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 Rev 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 Caption Order Using External Link action
1. Connect your Rev account
2. Configure External Link
3. Optional- Configure Video Seconds Length
4. Optional- Configure Reference ID
5. Optional- Configure Speakers
6. Optional- Configure Subtitle Languages
7. Optional- Select one or more Output File Formats
8. Optional- Configure Burned-in Captions
9. Optional- Configure Rush
10. Optional- Configure Notification URL
11. Optional- Select a Notification Level
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 Caption Order Using External Link on Rev

Description:Submit a new caption order using a external link that contains the media. [See docs here.](https://www.rev.com/api/orderspostcaption)

Version:0.0.1

Key:rev-create-caption-order-external-link

View on GitHub

Rev Overview#

The Rev API offers transcription, caption, and translation services, which you can integrate into automated workflows on Pipedream. Imagine automatically transcribing recorded meetings, generating captions for user-generated video content, or translating documents on-the-fly. With Rev, you can streamline media production, enhance accessibility, and break down language barriers, all while maintaining high accuracy.

Action Code#

import rev from "../../rev.app.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "rev-create-caption-order-external-link",
  name: "Create Caption Order Using External Link",
  description: "Submit a new caption order using a external link that contains the media. [See docs here.](https://www.rev.com/api/orderspostcaption)",
  type: "action",
  version: "0.0.1",
  props: {
    rev,
    externalLink: {
      propDefinition: [
        rev,
        "externalLink",
      ],
    },
    videoLength: {
      propDefinition: [
        rev,
        "videoLength",
      ],
    },
    reference: {
      propDefinition: [
        rev,
        "reference",
      ],
    },
    speakers: {
      propDefinition: [
        rev,
        "speakers",
      ],
    },
    languages: {
      type: "string[]",
      label: "Subtitle Languages",
      description: "Language codes to request foreign language subtitles. Examples: `es-es`, `it`.",
      optional: true,
    },
    formats: {
      type: "string[]",
      label: "Output File Formats",
      description: "What file formats should the captions be optimized for. Defaults to `Subrip`.",
      options: constants.FILE_FORMATS,
      optional: true,
    },
    burnedInCaptions: {
      type: "boolean",
      label: "Burned-in Captions",
      description: "Should burned-in captions be generated? Requesting burned-in captions adds $0.30 per audio minute to the cost of your orders. Burned-in captions will be available to download via the API for 7 days after they are generated.",
      optional: true,
    },
    rush: {
      propDefinition: [
        rev,
        "rush",
      ],
    },
    notificationUrl: {
      propDefinition: [
        rev,
        "notificationUrl",
      ],
    },
    notificationLevel: {
      propDefinition: [
        rev,
        "notificationLevel",
      ],
    },
  },
  async run({ $ }) {
    await this.rev.placeOrder({
      data: {
        client_ref: this.reference,
        caption_options: {
          inputs: [
            {
              video_length_seconds: this.videoLength,
              external_link: this.externalLink,
              speakers: this.speakers,
            },
          ],
          subtitle_languages: this.languages,
          output_file_formats: this.formats,
          rush: this.rush,
          burned_in_captions: this.burnedInCaptions,
        },
        notification: {
          url: this.notificationUrl,
          level: this.notificationLevel,
        },
      },
    });
    $.export("$summary", "Successfully created caption order");
  },
};

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
Rev	`rev`	`app`	This component uses the Rev app.
External Link	`externalLink`	`string`	A link to a web page where the media is embedded, but not a link to the media file.
Video Seconds Length	`videoLength`	`integer`	Required, except for Youtube URLs.
Reference ID	`reference`	`string`	A reference number for the order, like the order ID tracked by another system.
Speakers	`speakers`	`string[]`	List of speaker names.
Subtitle Languages	`languages`	`string[]`	Language codes to request foreign language subtitles. Examples: `es-es`, `it`.
Output File Formats	`formats`	`string[]`	Select a value from the drop down menu:`{ "label": "SubRip - A simple subtitle text format first used by the SubRip program.", "value": "SubRip" }{ "label": "Scenarist - Scenarist Closed Caption, an older but popular format, used by many video authoring tools such as Adobe Premiere.", "value": "Scc" }{ "label": "MacCaption - A format used for high-definition Broadcast TV.", "value": "Mcc" }{ "label": "Timed Text - A W3C standard for specifying timed text to be displayed along with video.", "value": "Ttml" }{ "label": "Quicktime Timed Text - A proprietary text-based format for specifying timed text supported by Apple's Quicktime Authoring software.", "value": "QTtext" }{ "label": "Transcript - Plain-text format", "value": "Transcript" }{ "label": "WebVTT - The Web Video Text Tracks format is intended for marking up external text track resources. The main use for WebVTT files is captioning or subtitling video content.", "value": "WebVtt" }{ "label": "DFXP - The Distribution Format Exchange Profile is intended to be used for the purpose of transcoding or exchanging timed text information among legacy distribution content formats presently in use for subtitling and captioning functions.", "value": "Dfxp" }{ "label": "Cheetah.CAP - File format for Cheetah Captivator Offline", "value": "CheetahCap" }{ "label": "Spruce Subtitle File - A simple subtitle text format, originally used by DVD Studio Pro", "value": "Stl" }{ "label": "Avid DS Subtitle File -\tA captions file format for Avid DS Software", "value": "AvidDs" }{ "label": "Avid DVD Subtitle File - A captions file format for Avid DVD Software.", "value": "AvidDvd" }{ "label": "Facebook-ready SubRip - Standard SubRip file with Facebook file naming conventions.", "value": "FacebookSubRip" }{ "label": "EBU Subtitle File - A standardized data file format for subtitles, popular in Europe.", "value": "EbuStl" }`
Burned-in Captions	`burnedInCaptions`	`boolean`	Should burned-in captions be generated? Requesting burned-in captions adds $0.30 per audio minute to the cost of your orders. Burned-in captions will be available to download via the API for 7 days after they are generated.
Rush	`rush`	`boolean`	Should the order be rushed? Rush will deliver your files up to 5x faster. Requesting Rush adds $1.25 per audio minute to the cost of your orders.
Notification URL	`notificationUrl`	`string`	The url for notifications. Can be a Pipedream Webhook.
Notification Level	`notificationLevel`	`string`	Select a value from the drop down menu:`{ "label": "A notification is sent whenever the order is in a new status or has a new comment.", "value": "Detailed" }{ "label": "[Default] A notification is sent only when the order is complete.", "value": "FinalOnly" }`

Action Authentication#

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

The get your API Keys, check Step 1 in Rev API Quickguide and have them sent to your email by clicking in the "get them here" link.

About Rev#

Affordable, accurate, easy-to-use speech-to-text solutions powered by people and A.I working together. Rev offers transcripts, captions, subtitles, and more.