Create Avatar Video with JoggAI API on New Comment Added (Instant) from Smartsheet API

Pipedream makes it easy to connect APIs for JoggAI, Smartsheet and 2,700+ other apps remarkably fast.

Trigger workflow on

New Comment Added (Instant) from the Smartsheet API

Next, do this

Create Avatar Video with the JoggAI 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 Smartsheet trigger and JoggAI action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Comment Added (Instant) trigger
1. Connect your Smartsheet account
2. Select a Sheet
Configure the Create Avatar Video action
1. Connect your JoggAI account
2. Select a Screen Style
3. Select a Avatar Type
4. Select a Avatar ID
5. Select a Voice Type
6. Select a Voice ID
7. Optional- Configure Script
8. Optional- Configure Audio URL
9. Select a Aspect Ratio
10. Optional- Configure Caption
11. Optional- Configure Video Name
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 Comment Added (Instant) on Smartsheet

Description:Emit new event when a comment is added in a sheet.

Version:0.0.2

Key:smartsheet-new-comment-added

View on GitHub

Smartsheet Overview#

The Smartsheet API unlocks the power of managing and automating complex workflows, directly interacting with Smartsheet's features such as sheets, rows, columns, and attachments. You can create, read, update, and delete sheets, share them with others, and extract complex data reports. Leveraging the API on Pipedream allows for seamless integration with other services for enhanced productivity and data management. Whether you're orchestrating an approval process, syncing data across platforms, or automating project tracking, the Smartsheet API pairs with Pipedream's serverless platform to build powerful, scalable, and automated workflows.

Trigger Code#

import common from "../common/base.mjs";

export default {
  ...common,
  key: "smartsheet-new-comment-added",
  name: "New Comment Added (Instant)",
  description: "Emit new event when a comment is added in a sheet.",
  version: "0.0.2",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getWebhookName() {
      return "Pipedream New Comment Added";
    },
    isRelevant({
      objectType, eventType,
    }) {
      return objectType === "comment" && eventType === "created";
    },
    generateMeta(event) {
      return {
        id: event.id,
        summary: `Comment ${event.id} added`,
        ts: Date.parse(event.timestamp),
      };
    },
    async getResource(event) {
      return this.smartsheet.getComment(this.sheetId, event.id);
    },
  },
};

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
Smartsheet	`smartsheet`	`app`	This component uses the Smartsheet app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
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.
Sheet	`sheetId`	`integer`	Select a value from the drop down menu.

Trigger Authentication#

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

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

ADMIN_SHEETSADMIN_SIGHTSADMIN_USERSADMIN_WEBHOOKSADMIN_WORKSPACESCREATE_SHEETSCREATE_SIGHTSDELETE_SHEETSDELETE_SIGHTSREAD_CONTACTSREAD_SHEETSREAD_SIGHTSREAD_USERSSHARE_SHEETSSHARE_SIGHTSWRITE_SHEETS

About Smartsheet#

Dynamic work & collaboration software

Action#

Create Avatar Video on JoggAI

Description:Creates an avatar video using JoggAI API. [See the documentation](https://docs.jogg.ai/api-reference/Create-Avatar-Videos/CreateAvatarVideo)

Version:0.0.1

Key:joggai-create-avatar-video

View on GitHub

Action Code#

import {
  ASPECT_VIDEO_RATIO_OPTIONS,
  AVATAR_TYPE_OPTIONS,
  SCREEN_STYLE_OPTIONS,
  VOICE_TYPE_OPTIONS,
} from "../../common/constants.mjs";
import { checkResponse } from "../../common/utils.mjs";
import joggai from "../../joggai.app.mjs";

export default {
  key: "joggai-create-avatar-video",
  name: "Create Avatar Video",
  description: "Creates an avatar video using JoggAI API. [See the documentation](https://docs.jogg.ai/api-reference/Create-Avatar-Videos/CreateAvatarVideo)",
  version: "0.0.1",
  type: "action",
  props: {
    joggai,
    screenStyle: {
      type: "integer",
      label: "Screen Style",
      description: "Style of the screen.",
      options: SCREEN_STYLE_OPTIONS,
    },
    avatarType: {
      type: "string",
      label: "Avatar Type",
      description: "Source type of the avatar.",
      options: AVATAR_TYPE_OPTIONS,
    },
    avatarId: {
      propDefinition: [
        joggai,
        "avatarId",
        ({ avatarType }) => ({
          avatarType,
        }),
      ],
    },
    voiceType: {
      type: "string",
      label: "Voice Type",
      description: "Source type of the voice.",
      options: VOICE_TYPE_OPTIONS,
    },
    voiceId: {
      propDefinition: [
        joggai,
        "voiceId",
        ({ voiceType }) => ({
          voiceType,
        }),
      ],
    },
    script: {
      type: "string",
      label: "Script",
      description: "Script content for the avatar to speak. Must provide either script or `Audio URL`.",
      optional: true,
    },
    audioUrl: {
      type: "string",
      label: "Audio URL",
      description: "Url for Audio, either script or audio_url must be provided, but not both.",
      optional: true,
    },
    aspectRatio: {
      type: "string",
      label: "Aspect Ratio",
      description: "Aspect ratio of the output video.",
      options: ASPECT_VIDEO_RATIO_OPTIONS,
    },
    caption: {
      type: "boolean",
      label: "Caption",
      description: "Whether to add caption to the video.",
      optional: true,
    },
    videoName: {
      type: "string",
      label: "Video Name",
      description: "If you want to specify the name of the generated video, please use this parameter.",
      optional: true,
    },
  },
  async run({ $ }) {
    if (!this.script && !this.audioUrl) {
      throw new Error("You must provide at least one of `Script` or `Audio URL`.");
    }
    if (this.script && this.audioUrl) {
      throw new Error("You must provide either `Script` or `Audio URL`, but not both.");
    }

    const response = await this.joggai.createAvatarVideo({
      $,
      data: {
        screen_style: this.screenStyle,
        avatar_type: this.avatarType && parseInt(this.avatarType),
        avatar_id: this.avatarId,
        voice_id: this.voiceId,
        script: this.script,
        audio_url: this.audioUrl,
        aspect_ratio: this.aspectRatio && parseInt(this.aspectRatio),
        caption: this.caption,
        video_name: this.videoName,
      },
    });

    checkResponse(response);

    $.export("$summary", "Avatar video created successfully");
    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
JoggAI	`joggai`	`app`	This component uses the JoggAI app.
Screen Style	`screenStyle`	`integer`	Select a value from the drop down menu:`{ "label": "With Background", "value": 1 }{ "label": "Green Screen", "value": 2 }{ "label": "Black Screen", "value": 3 }`
Avatar Type	`avatarType`	`string`	Select a value from the drop down menu:`{ "label": "Jogg Avatars", "value": "0" }{ "label": "Your Avatars", "value": "1" }`
Avatar ID	`avatarId`	`integer`	Select a value from the drop down menu.
Voice Type	`voiceType`	`string`	Select a value from the drop down menu:`{ "label": "Jogg Voices", "value": "0" }{ "label": "Your Voices", "value": "1" }`
Voice ID	`voiceId`	`string`	Select a value from the drop down menu.
Script	`script`	`string`	Script content for the avatar to speak. Must provide either script or `Audio URL`.
Audio URL	`audioUrl`	`string`	Url for Audio, either script or audio_url must be provided, but not both.
Aspect Ratio	`aspectRatio`	`string`	Select a value from the drop down menu:`{ "label": "Portrait [9:16]", "value": "0" }{ "label": "Landscape [16:9]", "value": "1" }{ "label": "Square [1:1]", "value": "2" }`
Caption	`caption`	`boolean`	Whether to add caption to the video.
Video Name	`videoName`	`string`	If you want to specify the name of the generated video, please use this parameter.

Create Avatar Video with JoggAI API on New Comment Added (Instant) from Smartsheet API

Pipedream makes it easy to connect APIs for JoggAI, Smartsheet and 2,700+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,700+apps by most popular

1
-
24
of
2,700+
apps by most popular