Create Comment with Frame.io API on Custom Interval from Schedule API

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

Trigger workflow on

Custom Interval from the Schedule API

Next, do this

Create Comment with the Frame.io API

No credit card required

▶

Watch us build a workflow

4 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Schedule trigger and Frame.io action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Custom Interval trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Create Comment action
1. Connect your Frame.io account
2. Select a Account ID
3. Select a Asset ID
4. Configure Text
5. Optional- Configure Annotation
6. Optional- Configure Page
7. Optional- Configure Timestamp
8. Optional- Configure Duration
9. Optional- Configure Private
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#

Custom Interval on Schedule

Description:Trigger your workflow every N hours, minutes or seconds.

Version:0.0.2

Key:schedule-custom-interval

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

import schedule from "../../schedule.app.mjs";

export default {
  name: "Custom Interval",
  version: "0.0.2",
  key: "schedule-custom-interval",
  type: "source",
  description: "Trigger your workflow every N hours, minutes or seconds.",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
    },
  },
};

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
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

Create Comment on Frame.io

Description:Creates a new comment on an asset in Frame.io. [See the documentation](https://developer.frame.io/api/reference/operation/createComment/)

Version:0.0.2

Key:frame-create-comment

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.

Action Code#

import frame from "../../frame.app.mjs";

export default {
  key: "frame-create-comment",
  name: "Create Comment",
  description: "Creates a new comment on an asset in Frame.io. [See the documentation](https://developer.frame.io/api/reference/operation/createComment/)",
  version: "0.0.2",
  type: "action",
  props: {
    frame,
    accountId: {
      propDefinition: [
        frame,
        "accountId",
      ],
    },
    assetId: {
      propDefinition: [
        frame,
        "assetId",
        ({ accountId }) => ({
          accountId,
        }),
      ],
    },
    text: {
      type: "string",
      label: "Text",
      description: "The body of the comment.",
    },
    annotation: {
      type: "string",
      label: "Annotation",
      description: "Serialized list of geometry and/or drawing data. [Learn more here](https://developer.frame.io/docs/workflows-assets/working-with-annotations)",
      optional: true,
    },
    page: {
      type: "integer",
      label: "Page",
      description: "Page number for a comment (documents only).",
      optional: true,
    },
    timestamp: {
      type: "string",
      label: "Timestamp",
      description: "Timestamp for the comment, in frames, starting at 0.",
      optional: true,
    },
    duration: {
      type: "integer",
      label: "Duration",
      description: "Used to produce range-based comments, this is the duration measured in frames.",
      optional: true,
    },
    private: {
      type: "boolean",
      label: "Private",
      description: "Set to true to make your comment a \"Team-only Comment\" that won't be visible to anonymous reviewers or Collaborators.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      frame, assetId, text, annotation, page, timestamp, duration,
    } = this;
    const response = await frame.sendComment({
      $,
      assetId,
      data: {
        text,
        annotation,
        page,
        timestamp,
        duration,
        private: this.private,
      },
    });
    $.export("$summary", `Successfully created comment (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
Frame.io	`frame`	`app`	This component uses the Frame.io app.
Account ID	`accountId`	`string`	Select a value from the drop down menu.
Asset ID	`assetId`	`string`	Select a value from the drop down menu.
Text	`text`	`string`	The body of the comment.
Annotation	`annotation`	`string`	Serialized list of geometry and/or drawing data. Learn more here
Page	`page`	`integer`	Page number for a comment (documents only).
Timestamp	`timestamp`	`string`	Timestamp for the comment, in frames, starting at 0.
Duration	`duration`	`integer`	Used to produce range-based comments, this is the duration measured in frames.
Private	`private`	`boolean`	Set to true to make your comment a "Team-only Comment" that won't be visible to anonymous reviewers or Collaborators.

Action 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