Create Caption Order Using External Link with Rev API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Caption Order Using External Link with the Rev API

No credit card required

▶

Watch us build a workflow

4 min

Watch now ➜

Trusted by 800,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Create Caption Order Using External Link with the Rev API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

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
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Create Caption Order Using External Link with Rev API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Rev

Try it

Create Caption Order Using External Link with Rev API on New Submission from Typeform API

Typeform + Rev

Try it

Create Caption Order Using External Link with Rev API on Custom Events from Zoom API

Zoom + Rev

Try it

Create Caption Order Using External Link with Rev API on New Submission (Instant) from Jotform API

Jotform + Rev

Try it

Create Caption Order Using External Link with Rev API on New Custom Webhook Events from Stripe API

Stripe + Rev

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

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

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");
  },
};

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
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" }`