Generate Video with SpiritMe API on New Customer Created (Instant) from Shopify API

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

Trigger workflow on

New Customer Created (Instant) from the Shopify 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 Shopify 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 Customer Created (Instant) trigger
1. Connect your Shopify account
2. Optional- Configure Metafield Namespaces
3. Optional- Configure Private Metafield Namespaces
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 Customer Created (Instant) on Shopify

Description:Emit new event for each new customer added to a store.

Version:0.0.4

Key:shopify_developer_app-new-customer-created

View on GitHub

Shopify Overview#

The Shopify Admin REST & GraphQL API unleashes a myriad of possibilities to automate and enhance online store operations. It provides programmatic access to Shopify functionalities, allowing users to manage products, customers, orders, and more. Leveraging the Shopify Admin API within Pipedream, developers can create custom workflows that automate repetitive tasks, sync data across platforms, and respond dynamically to events in Shopify.

This integration can be used as a custom app on your store, or for automating actions on behalf of merchants through your Shopify app.

Looking for integrating into the Shopify Partner API for your apps, themes or referrals? Check out our Shopify Partner API integration.

Trigger Code#

import constants from "../common/constants.mjs";
import common from "../common/webhook-metafields.mjs";

export default {
  ...common,
  key: "shopify_developer_app-new-customer-created",
  name: "New Customer Created (Instant)",
  type: "source",
  description: "Emit new event for each new customer added to a store.",
  version: "0.0.4",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getTopic() {
      return constants.EVENT_TOPIC.CUSTOMERS_CREATE;
    },
    generateMeta(resource) {
      const ts = Date.parse(resource.created_at);
      return {
        id: resource.id,
        summary: `New Customer ${resource.id}.`,
        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
Shopify	`app`	`app`	This component uses the Shopify 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.
Metafield Namespaces	`metafieldNamespaces`	`string[]`	Array of namespaces for any metafields that should be included with each webhook. Metafield definitions can be found in your store's Settings -> Custom Data. Select a metafield to view its namespace under "Namespace and key". For example, if the value is `custom.test_metafield`, the namespace is `custom`.
Private Metafield Namespaces	`privateMetafieldNamespaces`	`string[]`	Array of namespaces for any private metafields that should be included with each webhook. Metafield definitions can be found in your store's Settings -> Custom Data. Select a metafield to view its namespace under "Namespace and key". For example, if the value is `custom.test_metafield`, the namespace is `custom`.

Trigger Authentication#

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

Get your Access Token

Create a custom app in Shopify to obtain your Admin API access token. See our detailed instructions here.

Enter your Admin API access token below, and save it in a secure location (we recommend using a password manager such as 1Password)

About Shopify#

Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.

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

Generate Video with SpiritMe API on New Customer Created (Instant) from Shopify API

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

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

Developers ♥ Pipedream

Get your Access Token

1-24of2,400+apps by most popular

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