Create Gist with GitHub API on Asset Uploaded from Shotstack API

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

Trigger workflow on

Asset Uploaded from the Shotstack API

Next, do this

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

Select this integration
Configure the Asset Uploaded trigger
1. Connect your Shotstack account
2. Configure Polling schedule
Configure the Create Gist action
1. Connect your GitHub account
2. Configure Description
3. Configure Files
4. Configure Public
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#

Asset Uploaded on Shotstack

Description:Trigger when a new media asset has been uploaded to the Shotstack API. [See the documentation here](https://shotstack.io/docs/api/?shell#list-sources).

Version:0.0.1

Key:shotstack-asset-uploaded

View on GitHub

Shotstack Overview#

The Shotstack API is a video editing platform that allows you to automate the creation and production of videos. With it, you can edit clips, add transitions, overlays, and backgrounds, and even include music in your videos. Integrating Shotstack with Pipedream can supercharge your workflow by automating the video creation process. You can trigger video edits in response to various events, manage assets, or even kick off rendering jobs based on data from other apps and services.

Trigger Code#

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

export default {
  ...common,
  key: "shotstack-asset-uploaded",
  name: "Asset Uploaded",
  description: "Trigger when a new media asset has been uploaded to the Shotstack API. [See the documentation here](https://shotstack.io/docs/api/?shell#list-sources).",
  type: "source",
  version: "0.0.1",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getResourceName() {
      return "data";
    },
    getResourceFn() {
      return this.app.listSources;
    },
    getResourceFnArgs() {
      return {};
    },
    resourceIsRelevant(resource) {
      const isRelevant = resource.attributes?.status === "ready";
      if (!isRelevant) {
        console.log(`Skipping asset ${resource.id} because it is not ready`);
        console.log(JSON.stringify(resource, null, 2));
      }
      return isRelevant;
    },
    generateMeta(resource) {
      const { source } = resource.attributes || {};
      const filename = source?.split("/").pop();
      return {
        id: resource.id,
        summary: `New Asset: ${filename}`,
        ts: Date.parse(resource.created),
      };
    },
  },
};

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
Shotstack	`app`	`app`	This component uses the Shotstack app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling schedule	`timer`	`$.interface.timer`	How often to poll the API

Trigger Authentication#

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

About Shotstack#

Revolutionizing how video is built. Create, edit and distribute thousands of bespoke, data driven videos in minutes with Shotstack.

Action#

Create Gist on GitHub

Description:Allows you to add a new gist with one or more files. [See the documentation](https://docs.github.com/en/rest/gists/gists?apiVersion=2022-11-28#create-a-gist)

Version:0.0.7

Key:github-create-gist

View on GitHub

GitHub Overview#

The GitHub API is a powerful gateway to interaction with GitHub's vast web of data and services, offering a suite of endpoints to manipulate and retrieve information on repositories, pull requests, issues, and more. Harnessing this API on Pipedream, you can orchestrate automated workflows that respond to events in real-time, manage repository data, streamline collaborative processes, and connect GitHub with other services for a more integrated development lifecycle.

Action Code#

import github from "../../github.app.mjs";
import utils from "../../actions/common/utils.mjs";

export default {
  key: "github-create-gist",
  name: "Create Gist",
  description: "Allows you to add a new gist with one or more files. [See the documentation](https://docs.github.com/en/rest/gists/gists?apiVersion=2022-11-28#create-a-gist)",
  version: "0.0.7",
  type: "action",
  props: {
    github,
    description: {
      label: "Description",
      description: "The description of the gist",
      type: "string",
    },
    files: {
      label: "Files",
      description: "The files that will be added to the gist. The key is the file name and the value is the content of the file. Ex: `{\"file1.txt\": \"content of file 1\", \"file2.txt\": \"content of file 2\"}`",
      type: "object",
    },
    public: {
      label: "Public",
      description: "Indicates whether the gist is public or not",
      type: "boolean",
    },
  },
  async run({ $ }) {
    const res = await this.github.createGist({
      description: this.description,
      files: utils.convertFiles(this.files),
      public: this.public,
    });

    $.export("$summary", `Successfully created gist with ID "${res.id}".`);
    return res;
  },
};

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
GitHub	`github`	`app`	This component uses the GitHub app.
Description	`description`	`string`	The description of the gist
Files	`files`	`object`	The files that will be added to the gist. The key is the file name and the value is the content of the file. Ex: `{"file1.txt": "content of file 1", "file2.txt": "content of file 2"}`
Public	`public`	`boolean`	Indicates whether the gist is public or not

Action Authentication#

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

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

repoadmin:orgadmin:public_keyadmin:org_hookgistprojectnotificationsuserwrite:discussionwrite:packagesread:packagesadmin:repo_hook

Create Gist with GitHub API on Asset Uploaded from Shotstack API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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