← HTTP / Webhook + Amara integrations

Add New Subtitles with Amara APIon New Requests (Payload Only) from HTTP / Webhook API

Pipedream makes it easy to connect APIs for Amara, HTTP / Webhook and 700+ other apps remarkably fast.

Trigger workflow on
New Requests (Payload Only) from the HTTP / Webhook API
Next, do this
Add New Subtitles with the Amara API
No credit card required
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

This integration creates a workflow with a HTTP / Webhook trigger and Amara action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Select this integration
  2. Configure the New Requests (Payload Only) trigger
    1. Connect your HTTP / Webhook account
  3. Configure the Add New Subtitles action
    1. Connect your Amara account
    2. Optional- Configure Team
    3. Select a Video ID
    4. Select a Language
    5. Optional- Select a Subtitles format
    6. Optional- Configure Subtitles
    7. Optional- Configure Subtitles URL
    8. Optional- Configure Title
    9. Optional- Configure Description
    10. Optional- Select a Action
  4. Deploy the workflow
  5. Send a test event to validate your setup
  6. Turn on the trigger

Details

This integration uses pre-built, open source 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

Description:Get a URL and emit the HTTP body as an event on every request
Version:0.1.1
Key:http-new-requests-payload-only

Trigger Code

import http from "../../http.app.mjs";

// Core HTTP component
// Returns a 200 OK response, emits the HTTP payload as an event
export default {
  key: "http-new-requests-payload-only",
  name: "New Requests (Payload Only)",
  // eslint-disable-next-line
  description: "Get a URL and emit the HTTP body as an event on every request",
  version: "0.1.1",
  type: "source",
  props: {
    // eslint-disable-next-line
    httpInterface: {
      type: "$.interface.http",
      customResponse: true,
    },
    http,
  },
  async run(event) {
    const { body } = event;
    this.httpInterface.respond({
      status: 200,
      body,
    });
    // Emit the HTTP payload
    this.$emit({
      body,
    });
  },
};

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.
LabelPropTypeDescription
N/AhttpInterface$.interface.httpThis component uses $.interface.http to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the run() method of the component.
HTTP / WebhookhttpappThis component uses the HTTP / Webhook app.

Trigger Authentication

The HTTP / Webhook API does not require authentication.

About HTTP / Webhook

Get a unique URL where you can send HTTP or webhook requests

Action

Description:Add new subtitles. [See the docs here](https://apidocs.amara.org/#add-new-subtitles)
Version:0.0.2
Key:amara-add-new-subtitles

Action Code

import amara from "../../amara.app.mjs";

export default {
  key: "amara-add-new-subtitles",
  name: "Add New Subtitles",
  description: "Add new subtitles. [See the docs here](https://apidocs.amara.org/#add-new-subtitles)",
  type: "action",
  version: "0.0.2",
  props: {
    amara,
    team: {
      propDefinition: [
        amara,
        "team",
      ],
    },
    videoId: {
      propDefinition: [
        amara,
        "videoId",
        ({ team }) => ({
          team,
        }),
      ],
    },
    language: {
      label: "Language",
      description: "Language code for the language of the subtitles",
      optional: false,
      propDefinition: [
        amara,
        "primaryAudioLanguageCode",
      ],
    },
    subFormat: {
      description: "The format used to parse the subs. The same formats as for fetching subtitles are accepted. (Defaults to `dfxp`).",
      propDefinition: [
        amara,
        "subFormat",
      ],
    },
    subtitles: {
      propDefinition: [
        amara,
        "subtitles",
      ],
    },
    subtitlesUrl: {
      propDefinition: [
        amara,
        "subtitlesUrl",
      ],
    },
    title: {
      propDefinition: [
        amara,
        "title",
      ],
    },
    description: {
      propDefinition: [
        amara,
        "description",
      ],
    },
    action: {
      propDefinition: [
        amara,
        "action",
        ({
          videoId, language,
        }) => ({
          videoId,
          language,
        }),
      ],
    },
  },
  async run({ $ }) {
    const {
      videoId,
      language,
      subFormat,
      subtitles,
      subtitlesUrl,
      title,
      description,
      action,
    } = this;

    const data = {
      sub_format: subFormat,
      subtitles,
      subtitles_url: subtitlesUrl,
      title,
      description,
      action,
    };

    const response = await this.amara.addNewSubtitles({
      $,
      videoId,
      language,
      data,
    });

    $.export("$summary", `Successfully added ${response.language.name} subtitles for "${response.video_title}"`);

    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.

LabelPropTypeDescription
AmaraamaraappThis component uses the Amara app.
Teamteamstring

Filter by team (e.g. amplify in https://amara.org/en/teams/amplify/). Leave blank for videos that are in the public area.

Video IDvideoIdstringSelect a value from the drop down menu.
LanguagelanguagestringSelect a value from the drop down menu.
Subtitles formatsubFormatstringSelect a value from the drop down menu.
Subtitlessubtitlesstring

The subtitles to submit, as a string, depending on Subtitles format. Enter an expression to preserve escape sequences (e.g. {{"WEBVTT\n\n00:01.000 --> 00:04.000\nNever drink liquid nitrogen.\n\n00:05.000 --> 00:09.000\n- It will perforate your stomach.\n- You could die."}}).

Subtitles URLsubtitlesUrlstring

Alternatively, subtitles can be given as a text file URL. The format depends on Subtitles format.

Titletitlestring

Give a title to the new revision.

Descriptiondescriptionstring

Give a description to the new revision.

ActionactionstringSelect a value from the drop down menu.

Action Authentication

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

In order to get an API Key, create a user on the Amara website, then go to the account page. At the bottom of the page you will find a "Generate new key" button.

About Amara

The Amara Editor is an award-winning caption and subtitle editor that’s free to use! It’s fun and easy to learn, and encourages collaboration.

More Ways to Connect Amara + HTTP / Webhook

About Pipedream

Stop writing boilerplate code, struggling with authentication and managing infrastructure. Start connecting APIs with code-level control when you need it — and no code when you don't.

Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
"The past few weeks, I truly feel like the clichéd 10x engineer."
@heyellieday