Submit Transcription Request with Castmagic API on New Events (Instant) from Twilio SendGrid API

Pipedream makes it easy to connect APIs for Castmagic, Twilio SendGrid and 2,400+ other apps remarkably fast.

Trigger workflow on

New Events (Instant) from the Twilio SendGrid API

Next, do this

Submit Transcription Request with the Castmagic 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 Twilio SendGrid trigger and Castmagic action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Events (Instant) trigger
1. Connect your Twilio SendGrid account
2. Select one or more Event Types
Configure the Submit Transcription Request action
1. Connect your Castmagic account
2. Configure File URL
3. Optional- Configure Boosted Words
4. Optional- Select a Language Code
5. Optional- Configure Language Detection
6. Optional- Configure Wait for Completion
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 Events (Instant) on Twilio SendGrid

Description:Emit new event when any of the specified SendGrid events is received

Version:0.0.6

Key:sendgrid-events

View on GitHub

Twilio SendGrid Overview#

The Twilio SendGrid API opens up a world of possibilities for email automation, enabling you to send emails efficiently and track their performance. With this API, you can programmatically create and send personalized email campaigns, manage contacts, and parse inbound emails for data extraction. When you harness the power of Pipedream, you can connect SendGrid to hundreds of other apps to automate workflows, such as triggering email notifications based on specific actions, syncing email stats with your analytics, or handling incoming emails to create tasks or tickets.

Trigger Code#

import common from "../common/http-based.mjs";
import deliveryEventTypes from "./delivery-event-types.mjs";
import engagementEventTypes from "./engagement-event-types.mjs";

export default {
  ...common,
  key: "sendgrid-events",
  name: "New Events (Instant)",
  description: "Emit new event when any of the specified SendGrid events is received",
  version: "0.0.6",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    eventTypes: {
      type: "string[]",
      label: "Event Types",
      description: "The type of events to listen to",
      options(context) {
        const { page } = context;
        if (page !== 0) {
          return {
            options: [],
          };
        }

        const options = [
          ...deliveryEventTypes,
          ...engagementEventTypes,
        ];
        return {
          options,
        };
      },
    },
  },
  methods: {
    ...common.methods,
    baseWebhookSettings() {
      // The list of events that a webhook can listen to. This method returns an
      // exhaustive list of all such flags disabled, and each event source can
      // then override the flags that are relevant to the event they handle.
      //
      // See the docs for more information:
      // https://sendgrid.com/docs/api-reference/
      const eventTypesData = [
        ...deliveryEventTypes,
        ...engagementEventTypes,
      ];
      return eventTypesData.reduce((accum, eventTypeData) => ({
        ...accum,
        [eventTypeData.value]: false,
      }), {});
    },
    webhookEventFlags() {
      return this.eventTypes.reduce((accum, eventType) => ({
        ...accum,
        [eventType]: true,
      }), {});
    },
    generateMeta(data) {
      const {
        event: eventType,
        sg_event_id: id,
        timestamp: ts,
      } = data;
      const summary = `New event: ${eventType}`;
      return {
        id,
        summary,
        ts,
      };
    },
  },
};

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
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Twilio SendGrid	`sendgrid`	`app`	This component uses the Twilio SendGrid app.
N/A	`http`	`$.interface.http`	This 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.
Event Types	`eventTypes`	`string[]`	Select a value from the drop down menu.

Trigger Authentication#

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

About Twilio SendGrid#

Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.

Action#

Submit Transcription Request on Castmagic

Description:Submits a request to transcribe from a URL. [See the documentation](https://docs.castmagic.io/endpoints/transcripts)

Version:0.0.1

Key:castmagic-submit-transcription-request

View on GitHub

Castmagic Overview#

The Castmagic API allows you to control and automate the casting of media to various devices, such as Chromecast and smart TVs. It's designed for developers who want to build custom casting solutions without the hassle of dealing with low-level protocol details. Through Pipedream, you can integrate Castmagic with a myriad of services and triggers, creating workflows that respond to events like new content releases, user interactions, or scheduled routines. You can leverage Pipedream's serverless platform to create, run, and maintain these automations with ease.

Action Code#

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

export default {
  key: "castmagic-submit-transcription-request",
  name: "Submit Transcription Request",
  description: "Submits a request to transcribe from a URL. [See the documentation](https://docs.castmagic.io/endpoints/transcripts)",
  version: "0.0.1",
  type: "action",
  props: {
    castmagic,
    url: {
      type: "string",
      label: "File URL",
      description: "URL of the recording file to transcribe. Supported formats: aac, m4a, mp4, mpeg, wav, Public YouTube videos",
    },
    boostedWords: {
      type: "string[]",
      label: "Boosted Words",
      description: "List of words to boost when transcribing",
      optional: true,
    },
    languageCode: {
      type: "string",
      label: "Language Code",
      description: "Language code. Defaults to `en`.",
      options: constants.LANGUAGES,
      optional: true,
    },
    languageDetection: {
      type: "boolean",
      label: "Language Detection",
      description: "Attempt to automatically detect the content language. Will be overridden by `language_code` if included",
      optional: true,
    },
    waitForCompletion: {
      type: "boolean",
      label: "Wait for Completion",
      description: "Set to `true` to poll the API in 3-second intervals until the transcription is completed",
      optional: true,
    },
  },
  async run({ $ }) {
    let response = await this.castmagic.submitTranscriptionRequest({
      $,
      data: {
        url: this.url,
        boosted_words: this.boostedWords,
        language_code: this.languageCode,
        language_detection: this.languageDetection,
      },
    });

    if (this.waitForCompletion) {
      const timer = (ms) => new Promise((res) => setTimeout(res, ms));
      while (response.status !== "completed") {
        response = await this.castmagic.getTranscription({
          $,
          transcriptionId: response.id,
        });
        if (response.status === "error") {
          throw new Error(`${response.error}`);
        }
        await timer(3000);
      }
    }

    $.export("$summary", `Successfully created transcription request 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
Castmagic	`castmagic`	`app`	This component uses the Castmagic app.
File URL	`url`	`string`	URL of the recording file to transcribe. Supported formats: aac, m4a, mp4, mpeg, wav, Public YouTube videos
Boosted Words	`boostedWords`	`string[]`	List of words to boost when transcribing
Language Code	`languageCode`	`string`	Select a value from the drop down menu:`{ "value": "en", "label": "English" }{ "value": "de", "label": "German" }{ "value": "es", "label": "Spanish" }{ "value": "fr", "label": "French" }{ "value": "hi", "label": "Hindi" }{ "value": "id", "label": "Indonesian" }{ "value": "it", "label": "Italian" }{ "value": "ja", "label": "Japanese" }{ "value": "ko", "label": "Korean" }{ "value": "nl", "label": "Dutch" }{ "value": "no", "label": "Norwegian" }{ "value": "pl", "label": "Polish" }{ "value": "pt", "label": "Portuguese" }{ "value": "ru", "label": "Russian" }{ "value": "sv", "label": "Swedish" }{ "value": "tr", "label": "Turkish" }{ "value": "uk", "label": "Ukrainian" }{ "value": "zh", "label": "Mandarin (Simplified)" }`
Language Detection	`languageDetection`	`boolean`	Attempt to automatically detect the content language. Will be overridden by `language_code` if included
Wait for Completion	`waitForCompletion`	`boolean`	Set to `true` to poll the API in 3-second intervals until the transcription is completed