Generate Video with SpiritMe API on New Ticket Added to View (Instant) from Zendesk API

Pipedream makes it easy to connect APIs for SpiritMe, Zendesk and 2,400+ other apps remarkably fast.

Trigger workflow on

New Ticket Added to View (Instant) from the Zendesk API

Next, do this

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

Select this integration
Configure the New Ticket Added to View (Instant) trigger
1. Connect your Zendesk account
2. Select a Trigger Category ID
3. Optional- Configure Custom Subdomain
4. Optional- Select one or more Fields
5. Optional- Configure JSON Body
6. Select a View ID
Configure the Generate Video action
1. Connect your SpiritMe account
2. Configure Name
3. Optional- Select a Avatar
4. Optional- Select a Voice
5. Optional- Configure Text
6. Optional- Select a Audio File
7. Optional- Select a Media File
8. Optional- Select a View Type
9. Optional- Configure Auto Emotions Markup
10. 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 Ticket Added to View (Instant) on Zendesk

Description:Emit new event when a ticket is added to the specified view

Version:0.0.2

Key:zendesk-ticket-added-to-view

View on GitHub

Zendesk Overview#

The Zendesk API enables seamless integration of Zendesk's customer service platform with your existing business processes and third-party applications. By leveraging this API with Pipedream, you can automate ticket tracking, sync customer data, escalate issues, and streamline communication across multiple channels. This can significantly increase efficiency, accelerate response times, and enhance the overall customer experience. Automations can range from simple notifications to complex workflows involving data transformation and multi-step actions across various services.

Trigger Code#

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

export default {
  ...common,
  key: "zendesk-ticket-added-to-view",
  name: "New Ticket Added to View (Instant)",
  description: "Emit new event when a ticket is added to the specified view",
  version: "0.0.2",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    viewId: {
      propDefinition: [
        common.props.app,
        "viewId",
      ],
    },
  },
  methods: {
    ...common.methods,
    getWebhookName() {
      return "Ticket Added To View Webhook";
    },
    getTriggerTitle() {
      return "Ticket Added To View Trigger";
    },
    getTriggerConditions() {
      return {
        any: [
          {
            field: "update_type",
            value: "Change",
          },
          {
            field: "update_type",
            value: "Create",
          },
        ],
      };
    },
    async isRelevant(payload) {
      const { tickets } = await this.app.listTicketsInView({
        viewId: this.viewId,
      });
      const foundTicket = tickets.find(({ id }) => id == payload.ticketId);
      return foundTicket;
    },
  },
};

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
Zendesk	`app`	`app`	This component uses the Zendesk 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.
Trigger Category ID	`categoryId`	`string`	Select a value from the drop down menu.
Custom Subdomain	`customSubdomain`	`string`	For Enterprise Zendesk accounts: optionally specify the subdomain to use. This will override the subdomain that was provided when connecting your Zendesk account to Pipedream. For example, if you Zendesk URL is https://examplehelp.zendesk.com, your subdomain is `examplehelp`
Fields	`fields`	`string[]`	Select a value from the drop down menu.
JSON Body	`jsonBody`	`string`	Custom JSON Body of the incoming payload. Setting `jsonBody` will overwrite the `fields` prop
View ID	`viewId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

triggers:writewebhooks:writereadtickets:writetickets:readusers:writeorganizations:readorganizations:write

About Zendesk#

Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.

Action#

Generate Video on SpiritMe

Description:Generates a new video using specific voice and avatar props. [See the documentation](https://api.spiritme.tech/api/swagger/#/videos/videos_create)

Version:0.0.1

Key:spiritme-generate-video

View on GitHub

Action Code#

import spiritme from "../../spiritme.app.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "spiritme-generate-video",
  name: "Generate Video",
  description: "Generates a new video using specific voice and avatar props. [See the documentation](https://api.spiritme.tech/api/swagger/#/videos/videos_create)",
  version: "0.0.1",
  type: "action",
  props: {
    spiritme,
    name: {
      type: "string",
      label: "Name",
      description: "Name of the video",
    },
    avatar: {
      propDefinition: [
        spiritme,
        "avatar",
      ],
    },
    voice: {
      propDefinition: [
        spiritme,
        "voice",
      ],
    },
    text: {
      type: "string",
      label: "Text",
      description: "The text to use for the video. Example: `Hello everyone! I am a virtual avatar from Spiritme.` Use tags `<emotion name=\"emotion_name\"> text </emotion>` to add emotions to the generated video. The list of supported emotions are `neutral`, `semismile`, `smile`, `happiness`, `sadness`, and `surprise`. Either text or audio file is required.",
      optional: true,
    },
    audioFile: {
      propDefinition: [
        spiritme,
        "file",
        () => ({
          type: [
            "audio",
          ],
        }),
      ],
      label: "Audio File",
      description: "Identifier of an audio file. Either text or audio file is required.",
    },
    media: {
      propDefinition: [
        spiritme,
        "file",
        () => ({
          type: [
            "image",
            "video",
          ],
        }),
      ],
      label: "Media File",
      description: "Identifier of an image or video file. One of avatar or media is required.",
    },
    viewType: {
      type: "string",
      label: "View Type",
      description: "Content as is or content in circle. Supported only for avatars.",
      optional: true,
      options: [
        "rectangular",
        "circular",
      ],
    },
    autoEmotionsMarkup: {
      type: "boolean",
      label: "Auto Emotions Markup",
      description: "Add emotions automatically by AI",
      optional: true,
    },
    waitForCompletion: {
      type: "boolean",
      label: "Wait For Completion",
      description: "Set to `true` to poll the API in 3-second intervals until the video is completed",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      spiritme,
      name,
      avatar,
      voice,
      text,
      audioFile,
      media,
      viewType,
      autoEmotionsMarkup,
      waitForCompletion,
    } = this;

    if (!avatar && !media) {
      throw new ConfigurationError("One of `Avatar` or `Media File` is required");
    }

    if (!text && !audioFile) {
      throw new ConfigurationError("One of `Text` or `Audio File` is required");
    }

    let response = await spiritme.generateVideo({
      $,
      data: {
        name,
        slides: [
          {
            audio_source: {
              text,
              voice: voice
                ? {
                  id: voice,
                }
                : undefined,
              file: audioFile
                ? {
                  id: audioFile,
                }
                : undefined,
            },
            layers: [
              {
                avatar: avatar
                  ? {
                    id: avatar,
                  }
                  : undefined,
                media: media
                  ? {
                    id: media,
                  }
                  : undefined,
                view_type: viewType,
              },
            ],
          },
        ],
        auto_emotions_markup: autoEmotionsMarkup,
      },
    });

    if (waitForCompletion) {
      const timer = (ms) => new Promise((res) => setTimeout(res, ms));
      while (response.status !== "success") {
        response = await spiritme.getVideo({
          videoId: response.id,
        });
        await timer(3000);
      }
    }

    $.export("$summary", `Generated video 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
SpiritMe	`spiritme`	`app`	This component uses the SpiritMe app.
Name	`name`	`string`	Name of the video
Avatar	`avatar`	`string`	Select a value from the drop down menu.
Voice	`voice`	`string`	Select a value from the drop down menu.
Text	`text`	`string`	The text to use for the video. Example: `Hello everyone! I am a virtual avatar from Spiritme.` Use tags `<emotion name="emotion_name"> text </emotion>` to add emotions to the generated video. The list of supported emotions are `neutral`, `semismile`, `smile`, `happiness`, `sadness`, and `surprise`. Either text or audio file is required.
Audio File	`audioFile`	`string`	Select a value from the drop down menu.
Media File	`media`	`string`	Select a value from the drop down menu.
View Type	`viewType`	`string`	Select a value from the drop down menu:`rectangularcircular`
Auto Emotions Markup	`autoEmotionsMarkup`	`boolean`	Add emotions automatically by AI
Wait For Completion	`waitForCompletion`	`boolean`	Set to `true` to poll the API in 3-second intervals until the video is completed