Submit Video URL with Symbl.ai API on New Scheduled Tasks from Pipedream API

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

Trigger workflow on

New Scheduled Tasks from the Pipedream API

Next, do this

Submit Video URL with the Symbl.ai API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

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

Select this integration
Configure the New Scheduled Tasks trigger
1. Connect your Pipedream account
2. Optional- Configure Secret
Configure the Submit Video URL action
1. Connect your Symbl.ai account
2. Configure Video URL
3. Optional- Configure Meeting Name
4. Optional- Configure Custom Vocabulary
5. Optional- Configure Confidence Threshold
6. Optional- Configure Detect Phrases
7. Optional- Configure Webhook URL
8. Optional- Configure Detect Entities
9. Optional- Select a Language Code
10. Optional- Select a Mode
11. Optional- Configure Enable Separate Recognition per Channel
12. Optional- Configure Enable All Trackers
13. Optional- Configure Enable Speaker Diarization
14. Optional- Configure Number of Speakers
15. Optional- Configure Trackers
16. Optional- Configure Channel Metadata
17. Optional- Configure Enable Summary
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 Scheduled Tasks on Pipedream

Description:Exposes an HTTP API for scheduling messages to be emitted at a future time

Version:0.3.1

Key:pipedream-new-scheduled-tasks

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Trigger Code#

import pipedream from "../../pipedream.app.mjs";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";

export default {
  key: "pipedream-new-scheduled-tasks",
  name: "New Scheduled Tasks",
  type: "source",
  description:
    "Exposes an HTTP API for scheduling messages to be emitted at a future time",
  version: "0.3.1",
  dedupe: "unique", // Dedupe on a UUID generated for every scheduled task
  props: {
    pipedream,
    secret: {
      type: "string",
      secret: true,
      label: "Secret",
      optional: true,
      description:
        "**Optional but recommended**: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests",
    },
    http: {
      label: "Endpoint",
      description: "The endpoint where you'll send task scheduler requests",
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
  },
  methods: {
    // To schedule future emits, we emit to the selfChannel of the component
    selfChannel() {
      return "self";
    },
    // Queue for future emits that haven't yet been delivered
    queuedEventsChannel() {
      return "$in";
    },
    httpRespond({
      status, body,
    }) {
      this.http.respond({
        headers: {
          "content-type": "application/json",
        },
        status,
        body,
      });
    },
    async selfSubscribe() {
      // Subscribe the component to itself. We do this here because even in
      // the activate hook, the component isn't available to take subscriptions.
      // Scheduled tasks are sent to the self channel, which emits the message at
      // the specified delivery_ts to this component.
      const isSubscribedToSelf = this.db.get("isSubscribedToSelf");
      if (!isSubscribedToSelf) {
        const componentId = process.env.PD_COMPONENT;
        const selfChannel = this.selfChannel();
        console.log(`Subscribing to ${selfChannel} channel for event source`);
        console.log(
          await this.pipedream.subscribe(componentId, componentId, selfChannel),
        );
        this.db.set("isSubscribedToSelf", true);
      }
    },
    validateEventBody(event, operation) {
      const errors = [];

      // Secrets are optional, so we first check if the user configured
      // a secret, then check its value against the prop (validation below)
      if (this.secret && event.headers["x-pd-secret"] !== this.secret) {
        errors.push(
          "Secret on incoming request doesn't match the configured secret",
        );
      }

      if (operation === "schedule") {
        const {
          timestamp,
          message,
        } = event.body;
        // timestamp should be an ISO 8601 string. Parse and check for validity below.
        const epoch = Date.parse(timestamp);

        if (!timestamp) {
          errors.push(
            "No timestamp included in payload. Please provide an ISO8601 timestamp in the 'timestamp' field",
          );
        }
        if (timestamp && !epoch) {
          errors.push("Timestamp isn't a valid ISO 8601 string");
        }
        if (!message) {
          errors.push("No message passed in payload");
        }
      }

      return errors;
    },
    scheduleTask(event) {
      const errors = this.validateEventBody(event, "schedule");
      let status, body;

      if (errors.length) {
        console.log(errors);
        status = 400;
        body = {
          errors,
        };
      } else {
        const id = this.emitScheduleEvent(event.body, event.body.timestamp);
        status = 200;
        body = {
          msg: "Successfully scheduled task",
          id,
        };
      }

      this.httpRespond({
        status,
        body,
      });
    },
    emitScheduleEvent(event, timestamp) {
      const selfChannel = this.selfChannel();
      const epoch = Date.parse(timestamp);
      const $id = uuid();

      console.log(`Scheduled event to emit on: ${new Date(epoch)}`);

      this.$emit(
        {
          ...event,
          $channel: selfChannel,
          $id,
        },
        {
          name: selfChannel,
          id: $id,
          delivery_ts: epoch,
        },
      );

      return $id;
    },
    async cancelTask(event) {
      const errors = this.validateEventBody(event, "cancel");
      let status, msg;

      if (errors.length) {
        console.log(errors);
        status = 400;
        msg = "Secret on incoming request doesn't match the configured secret";
      } else {
        try {
          const id = event.body.id;
          const isCanceled = await this.deleteEvent(event);
          if (isCanceled) {
            status = 200;
            msg = `Cancelled scheduled task for event ${id}`;
          } else {
            status = 404;
            msg = `No event with ${id} found`;
          }
        } catch (error) {
          console.log(error);
          status = 500;
          msg = "Failed to schedule task. Please see the logs";
        }
      }

      this.httpRespond({
        status,
        body: {
          msg,
        },
      });
    },
    async deleteEvent(event) {
      const componentId = process.env.PD_COMPONENT;
      const inChannel = this.queuedEventsChannel();

      // The user must pass a scheduled event UUID they'd like to cancel
      // We lookup the event by ID and delete it
      const { id } = event.body;

      // List events in the $in channel - the queue of scheduled events, to be emitted in the future
      const events = await this.pipedream.listEvents(
        componentId,
        inChannel,
      );
      console.log("Events: ", events);

      // Find the event in the list by id
      const eventToCancel = events.data.find((e) => {
        const { metadata } = e;
        return metadata.id === id;
      });

      console.log("Event to cancel: ", eventToCancel);

      if (!eventToCancel) {
        console.log(`No event with ${id} found`);
        return false;
      }

      // Delete the event
      await this.pipedream.deleteEvent(
        componentId,
        eventToCancel.id,
        inChannel,
      );
      return true;
    },
    emitEvent(event, summary) {
      // Delete the channel name and id from the incoming event, which were used only as metadata
      const id = event.$id;
      delete event.$channel;
      delete event.$id;

      this.$emit(event, {
        summary: summary ?? JSON.stringify(event),
        id,
        ts: +new Date(),
      });
    },
  },
  async run(event) {
    await this.selfSubscribe();

    const { path } = event;
    if (path === "/schedule") {
      this.scheduleTask(event);
    } else if (path === "/cancel") {
      await this.cancelTask(event);
    } else if (event.$channel === this.selfChannel()) {
      this.emitEvent(event);
    }
  },
  sampleEmit,
};

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
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Secret	`secret`	`string`	Optional but recommended: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests
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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

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

About Pipedream#

Integration platform for developers

Action#

Submit Video URL on Symbl.ai

Description:Submit a Video file by providing the URL for processing. See the doc [here](https://docs.symbl.ai/docs/async-api/overview/video/post-video-url).

Version:0.0.9

Key:symbl_ai-post-video-url

View on GitHub

Symbl.ai Overview#

The Symbl.ai API supercharges your applications with advanced conversation intelligence. By tapping into Symbl.ai via Pipedream, you can automate the analysis of voice, text, and video communications. Extract actionable items, follow-ups, and insights in real-time or from recorded content. This API's magic lies in its ability to provide contextually relevant insights, topic detection, sentiment analysis, and conversation metrics without extensive training data or setup time.

Action Code#

import symblAIApp from "../../symbl_ai.app.mjs";
import languages from "../common/languages.mjs";
import utils from "../common/utils.mjs";

export default {
  key: "symbl_ai-post-video-url",
  name: "Submit Video URL",
  description: "Submit a Video file by providing the URL for processing. See the doc [here](https://docs.symbl.ai/docs/async-api/overview/video/post-video-url).",
  version: "0.0.9",
  type: "action",
  props: {
    symblAIApp,
    videoUrl: {
      type: "string",
      label: "Video URL",
      description: "The URL of the video file to be processed.",
    },
    meetingName: {
      type: "string",
      label: "Meeting Name",
      description: "The meeting name. The default name is set to the conversationId.",
      optional: true,
    },
    customVocabulary: {
      type: "string[]",
      label: "Custom Vocabulary",
      description: "List of words and phrases that provide hints to the speech recognition task.",
      optional: true,
    },
    confidenceThreshold: {
      type: "string",
      label: "Confidence Threshold",
      description: "Minimum confidence score that you can set for an API to consider it as a valid insight (action items, follow-ups, topics, and questions). It should be in the range <=0.5 to <=1.0 (i.e., greater than or equal to 0.5 and less than or equal to 1.0.). The default value is 0.5.",
      optional: true,
    },
    detectPhrases: {
      type: "boolean",
      label: "Detect Phrases",
      description: "It shows Actionable Phrases in each sentence of conversation. These sentences can be found using the Conversation's Messages API. Accepts `true` or `false` values.",
      optional: true,
    },
    webhookUrl: {
      type: "string",
      label: "Webhook URL",
      description: "Webhook URL on which job updates to be sent.",
      optional: true,
    },
    detectEntities: {
      type: "boolean",
      label: "Detect Entities",
      description: "It returns any entities detected in the conversation. See [Entities API](https://docs.symbl.ai/docs/conversation-api/entities) for reference. Default value is false.",
      optional: true,
    },
    languageCode: {
      type: "string",
      label: "Language Code",
      description: "Language used in the conversation. See [supported languages](https://docs.symbl.ai/docs/async-api/overview/async-api-supported-languages) for reference. Default language is English (en-US).",
      options: languages,
      optional: true,
    },
    mode: {
      type: "string",
      label: "Mode",
      description: "Set this parameter to `phone` when the audio is generated from a phone call (8khz sampling rate). The `default` mode works for audio generated from a video or audio meeting (16khz or higher sampling rate).",
      options: [
        "default",
        "phone",
      ],
      optional: true,
    },
    enableSeparateRecognitionPerChannel: {
      type: "boolean",
      label: "Enable Separate Recognition per Channel",
      description: "Enables Speaker Separated Channel video processing. Accepts `true` or `false` values.",
      optional: true,
    },
    enableAllTrackers: {
      type: "boolean",
      label: "Enable All Trackers",
      description: "Set this parameter to `true` to enable detection of all the Trackers configured for your account. Default value is `false`.",
      optional: true,
    },
    enableSpeakerDiarization: {
      type: "boolean",
      label: "Enable Speaker Diarization",
      description: "Set this parameter to `true` to enable Speaker Separation. Default value is `false`.  See [Speaker Separation](https://docs.symbl.ai/docs/async-api/overview/video/post-video-url/#speaker-separation) for reference.",
      optional: true,
    },
    diarizationSpeakerCount: {
      type: "string",
      label: "Number of Speakers",
      description: "The number of unique speakers in this conversation. See [Speaker Separation](https://docs.symbl.ai/docs/async-api/overview/video/post-video-url/#speaker-separation) for reference.",
      optional: true,
    },
    trackers: {
      type: "string",
      label: "Trackers",
      description: "Provide a JSON array of the information to be tracked containing the `name` and the `vocabulary` information. The tracker object is represented by the following structure: `[{\"name\": \"Promotion Mention\",\"vocabulary\": [\"We have a special promotion going on if you book this before\",\"I can offer you a discount of 10 or 20 percent you being a new customer for us\",\"We have a sale right now on\"]}]`. See doc [here](https://docs.symbl.ai/docs/management-api/trackers/create-tracker).",
      optional: true,
    },
    channelMetadata: {
      type: "string",
      label: "Channel Metadata",
      description: "Provide a JSON array of participants with their `channel` and `speaker` information. Each participant object is represented by the following structure:  `[{\"channel\": 1,\"speaker\": {\"name\": \"Joe Doe\",\"email\": \"joe@doe.com\"}},{\"channel\": 2,\"speaker\": {\"name\": \"Mary Jones\",\"email\": \"mary@email.com\"}}]`. See doc [here](https://docs.symbl.ai/docs/async-api/overview/video/post-video#channel-metadata)",
      optional: true,
    },
    enableSummary: {
      type: "boolean",
      label: "Enable Summary",
      description: "Generate the Conversation summary automatically. Accepts `true` or `false` values.",
      optional: true,
    },
  },
  async run({ $ }) {
    const trackers = utils.emptyStrToUndefined(this.trackers);
    const channelMetadata = utils.emptyStrToUndefined(this.channelMetadata);
    const response =
      await this.symblAIApp.postVideoUrl({
        $,
        data: {
          url: this.videoUrl,
          name: this.meetingName,
          customVocabulary: this.customVocabulary,
          confidenceThreshold: this.confidenceThreshold,
          detectPhrases: this.detectPhrases,
          webhookUrl: this.webhookUrl,
          detectEntities: this.detectEntities,
          languageCode: this.languageCode,
          mode: this.mode,
          enableSeparateRecognitionPerChannel: this.enableSeparateRecognitionPerChannel,
          enableAllTrackers: this.enableAllTrackers,
          enableSpeakerDiarization: this.enableSpeakerDiarization,
          diarizationSpeakerCount: this.diarizationSpeakerCount,
          trackers: JSON.parse(trackers || "[]"),
          channelMetadata: JSON.parse(channelMetadata || "[]"),
          enableSummary: this.enableSummary,
        },
      });
    $.export("$summary", `Successfully posted video URL for processing with Conversation Id: ${response.conversationId} and Job Id: ${response.jobId}`);
    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
Symbl.ai	`symblAIApp`	`app`	This component uses the Symbl.ai app.
Video URL	`videoUrl`	`string`	The URL of the video file to be processed.
Meeting Name	`meetingName`	`string`	The meeting name. The default name is set to the conversationId.
Custom Vocabulary	`customVocabulary`	`string[]`	List of words and phrases that provide hints to the speech recognition task.
Confidence Threshold	`confidenceThreshold`	`string`	Minimum confidence score that you can set for an API to consider it as a valid insight (action items, follow-ups, topics, and questions). It should be in the range <=0.5 to <=1.0 (i.e., greater than or equal to 0.5 and less than or equal to 1.0.). The default value is 0.5.
Detect Phrases	`detectPhrases`	`boolean`	It shows Actionable Phrases in each sentence of conversation. These sentences can be found using the Conversation's Messages API. Accepts `true` or `false` values.
Webhook URL	`webhookUrl`	`string`	Webhook URL on which job updates to be sent.
Detect Entities	`detectEntities`	`boolean`	It returns any entities detected in the conversation. See Entities API for reference. Default value is false.
Language Code	`languageCode`	`string`	Select a value from the drop down menu:`{ "label": "English (United States)", "value": "en-US" }{ "label": "English (United Kingdom)", "value": "en-GB" }{ "label": "English (Australia)", "value": "en-AU" }{ "label": "English (Ireland)", "value": "en-IE" }{ "label": "English (India)", "value": "en-IN" }{ "label": "English (South Africa)", "value": "en-ZA" }{ "label": "Russian (Russian Federation)", "value": "ru-RU" }{ "label": "French (Canada)", "value": "fr-CA" }{ "label": "French (France)", "value": "fr-FR" }{ "label": "German (Germany)", "value": "de-DE" }{ "label": "Italian (Italy)", "value": "it-IT" }{ "label": "Dutch (Netherlands)", "value": "nl-NL" }{ "label": "Japanese (Japan)", "value": "ja-JP" }{ "label": "Spanish (United States)", "value": "es-US" }{ "label": "Spanish (Spain)", "value": "es-ES" }{ "label": "Arabic (Saudi Arabia)", "value": "ar-SA" }{ "label": "Hindi (India)", "value": "hi-IN" }{ "label": "Portuguese (Brazil)", "value": "pt-BR" }{ "label": "Portuguese (Portugal)", "value": "pt-PT" }{ "label": "Persian (Iran)", "value": "fa-IR" }`
Mode	`mode`	`string`	Select a value from the drop down menu:`defaultphone`
Enable Separate Recognition per Channel	`enableSeparateRecognitionPerChannel`	`boolean`	Enables Speaker Separated Channel video processing. Accepts `true` or `false` values.
Enable All Trackers	`enableAllTrackers`	`boolean`	Set this parameter to `true` to enable detection of all the Trackers configured for your account. Default value is `false`.
Enable Speaker Diarization	`enableSpeakerDiarization`	`boolean`	Set this parameter to `true` to enable Speaker Separation. Default value is `false`. See Speaker Separation for reference.
Number of Speakers	`diarizationSpeakerCount`	`string`	The number of unique speakers in this conversation. See Speaker Separation for reference.
Trackers	`trackers`	`string`	Provide a JSON array of the information to be tracked containing the `name` and the `vocabulary` information. The tracker object is represented by the following structure: `[{"name": "Promotion Mention","vocabulary": ["We have a special promotion going on if you book this before","I can offer you a discount of 10 or 20 percent you being a new customer for us","We have a sale right now on"]}]`. See doc here.
Channel Metadata	`channelMetadata`	`string`	Provide a JSON array of participants with their `channel` and `speaker` information. Each participant object is represented by the following structure: `[{"channel": 1,"speaker": {"name": "Joe Doe","email": "joe@doe.com"}},{"channel": 2,"speaker": {"name": "Mary Jones","email": "mary@email.com"}}]`. See doc here
Enable Summary	`enableSummary`	`boolean`	Generate the Conversation summary automatically. Accepts `true` or `false` values.

Action Authentication#

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

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

About Symbl.ai#

AI platform built for analyzing open domain human-to-human conversations

More Ways to Connect Symbl.ai + Pipedream#

Other Popular Integrations#

Get Job Status with Symbl.ai API on New Scheduled Tasks from Pipedream API

Pipedream + Symbl.ai

Try it

Get Action Items with Symbl.ai API on New Scheduled Tasks from Pipedream API

Pipedream + Symbl.ai

Try it

Get Follow-Ups with Symbl.ai API on New Scheduled Tasks from Pipedream API

Pipedream + Symbl.ai

Try it

Get Questions with Symbl.ai API on New Scheduled Tasks from Pipedream API

Pipedream + Symbl.ai

Try it

Get Speech to Text with Symbl.ai API on New Scheduled Tasks from Pipedream API

Pipedream + Symbl.ai

Try it

Popular Triggers#

New Scheduled Tasks from the Pipedream API

Exposes an HTTP API for scheduling messages to be emitted at a future time

Try it

New Upcoming Event Alert from the Pipedream API

Emit new event based on a time interval before an upcoming event in the calendar. This source uses Pipedream's Task Scheduler. See the documentation for more information and instructions for connecting your Pipedream account.

Try it

New Upcoming Calendar Event from the Pipedream API

Emit new event when a Calendar event is upcoming, this source is using reminderMinutesBeforeStart property of the event to determine the time it should emit.

Try it

New Upcoming Event Type Alert from the Pipedream API

Emit new event based on a time interval before an upcoming event of the specified type ("default", "focusTime", "outOfOffice", "workingLocation") in the calendar. This source uses Pipedream's Task Scheduler. See the documentation for more information and instructions for connecting your Pipedream account.

Try it