[Data] Convert JSON to String with Formatting API on New Comment (Instant) from Frame.io API

Pipedream makes it easy to connect APIs for Formatting, Frame.io and 2,400+ other apps remarkably fast.

Trigger workflow on

New Comment (Instant) from the Frame.io API

Next, do this

[Data] Convert JSON to String with the Formatting 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 Frame.io trigger and Formatting 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 (Instant) trigger
1. Connect your Frame.io account
2. Select a Account ID
3. Select a Team ID
Configure the [Data] Convert JSON to String action
1. Connect your Formatting account
2. Configure Input
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 (Instant) on Frame.io

Description:Emit new event when a new comment is left on an asset. [See the documentation](https://developer.frame.io/api/reference/operation/createWebhookForTeam/)

Version:0.1.0

Key:frame-new-comment-instant

View on GitHub

Frame.io Overview#

The Frame.io API hooks into their robust video collaboration platform, enabling automated workflows around video reviews, project updates, and asset management. With the API, you can programmatically interact with comments, accounts, projects, and more—perfect for integrating with other tools to streamline video production pipelines.

Trigger Code#

import common from "../common/common.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "frame-new-comment-instant",
  name: "New Comment (Instant)",
  description: "Emit new event when a new comment is left on an asset. [See the documentation](https://developer.frame.io/api/reference/operation/createWebhookForTeam/)",
  version: "0.1.0",
  type: "source",
  sampleEmit,
  methods: {
    ...common.methods,
    getSummary() {
      return "New Comment";
    },
    getHookData() {
      return [
        "comment.created",
      ];
    },
    async getResourceData(id) {
      return this.app.getComment(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
Frame.io	`app`	`app`	This component uses the Frame.io app.
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.
Account ID	`accountId`	`string`	Select a value from the drop down menu.
Team ID	`teamId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

presentation.updatecomment.readasset.updatereviewlink.updatewebhook.createaccount.readaction.updatereviewlink.readpresentation.readaction.createpresentation.createauditlog.readteam.createcomment.createteam.readofflinereviewlink.deleteproject.updateproject.deletewebhook.deleteaction.deleteasset.deletewebhook.readasset.createcomment.deletewebhook.updateasset.readcomment.updateproject.readaction.readreviewlink.createpresentation.deleteproject.createteam.update

About Frame.io#

Video Review and Collaboration Software

Action#

[Data] Convert JSON to String on Formatting

Description:Convert an object to a JSON format string

Version:0.0.5

Key:formatting-convert-json-to-string

View on GitHub

Action Code#

import { defineAction } from "@pipedream/types";
import app from "../../app/formatting.app.mjs";
export default defineAction({
    name: "[Data] Convert JSON to String",
    description: "Convert an object to a JSON format string",
    key: "formatting-convert-json-to-string",
    version: "0.0.5",
    type: "action",
    props: {
        app,
        input: {
            label: "Input",
            description: "An object to be serialized to a JSON format string.",
            type: "object",
        },
    },
    async run({ $ }) {
        try {
            const result = JSON.stringify(this.input);
            $.export("$summary", "Successfully convert object to JSON string");
            return result;
        }
        catch (err) {
            throw new Error("Error serializing object to JSON string: " + err.toString());
        }
    },
});