ÃÛ¶¹ÊÓƵ

DocumentationWorkfrontWorkfront Guide

Frame.io modules

Last update: Thu Nov 21 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • User

The ÃÛ¶¹ÊÓƵ Workfront Fusion Frame.io modules enable you to monitor, create, update, retrieve, or delete assets and comments in your Frame.io account.

For a video introduction to the Frame.io connector, see:

Access requirements

You must have the following access to use the functionality in this article:

ÃÛ¶¹ÊÓƵ Workfront plan*
Pro or higher
ÃÛ¶¹ÊÓƵ Workfront license*
Plan, Work
ÃÛ¶¹ÊÓƵ Workfront Fusion license**

Current license requirement: No Workfront Fusion license requirement.

Or

Legacy license requirement: Workfront Fusion for Work Automation and Integration

Product

Current product requirement: If you have the Select or Prime ÃÛ¶¹ÊÓƵ Workfront plan, your organization must purchase ÃÛ¶¹ÊÓƵ Workfront Fusion as well as ÃÛ¶¹ÊÓƵ Workfront to use functionality described in this article. Workfront Fusion is included in the Ultimate Workfront plan.

Or

Legacy product requirement: Your organization must purchase ÃÛ¶¹ÊÓƵ Workfront Fusion as well as ÃÛ¶¹ÊÓƵ Workfront to use functionality described in this article.

To find out what plan, license type, or access you have, contact your Workfront administrator.

For information on ÃÛ¶¹ÊÓƵ Workfront Fusion licenses, see ÃÛ¶¹ÊÓƵ Workfront Fusion licenses.

Prerequisites

To use Frame.io modules, you must have a Frame.io account

Frame.io API information

The Frame.io connector uses the following:

Base URL
https://api.frame.io/v2
API version
v2
API tag
v1.0.76

Connect Frame.io to ÃÛ¶¹ÊÓƵ Workfront Fusion

You can connect to Frame.io using an API token, or by using OAuth 2.0.

Connect to Frame.io using an API token

Connect to Frame.io using OAuth 2.0 PKCE

Connect to Frame.io using an API token

To connect your Frame.io account to Workfront Fusion using an API token, you must create the API token in your Frame.io account and insert it to the Workfront Fusion Frame.io Create a connection dialog.

  1. Log in to your Frame.io account.
  2. Go to the Tokens page in the Frame.io Developer.
  3. Click New.
  4. Enter the name of the token, select the scopes you want to use, and click Create.
  5. Copy the provided token.
  6. Go to Workfront Fusion and open the Frame.io module’s Create a connection dialog.
  7. In the Connection type field, select Frame.io.
  8. Enter the token you have copied in step 5 to the Your Frame.io API Key field and click Continue to establish the connection.

The connection has been established. You can proceed with setting up the module.

Connect to Frame.io using OAuth 2.0 PKCE

You can create an connection to Frame.io using OAuth 2.0 PKCE with an optional Client ID. If you want to include a Client ID in your connection, you must create an OAuth 2.0 app in your Frame.io account.

Connect to Frame.io using using OAuth 2.0 PKCE (without Client ID)

  1. Go to Workfront Fusion and open the Frame.io module’s Create a connection dialog.
  2. In the Connection type field, select Frame.io OAuth 2.0 PKCE.
  3. Enter a name for the new connection in the Connection name field.
  4. Click Continue to establish the connection.

The connection has been established. You can proceed with setting up the module.

Connect to Frame.io using using OAuth 2.0 PKCE (with Client ID)

  1. Create an OAuth 2.0 app in Frame.io. For instructions, see the Frame.io documentation on OAuth 2.0 Code Authorization Flow.

    note important
    IMPORTANT
    When creating the OAuth 2.0 app in Frame.io:

    • Enter the following as the redirect URI:

      Americas / APAC https://app.workfrontfusion.com/oauth/cb/frame-io5

      EMEA https://app-eu.workfrontfusion.com/oauth/cb/frame-io5

    • Enable the PCKE option.

  2. Copy the provided client_id.

  3. Go to Workfront Fusion and open the Frame.io module’s Create a connection dialog.

  4. In the Connection type field, select Frame.io OAuth 2.0 PKCE.

  5. Enter a name for the new connection in the Connection name field.

  6. Click Show advanced settings.

  7. Enter the client_id you copied in step 2 to the Client ID field.

  8. Click Continue to establish the connection.

The connection has been established. You can proceed with setting up the module.

Frame.io modules and their fields

When you configure Frame.io modules, Workfront Fusion displays the fields listed below. Along with these, additional Frame.io fields might display, depending on factors such as your access level in the app or service. A bolded title in a module indicates a required field.

If you see the map button above a field or function, you can use it to set variables and functions for that field. For more information, see Map information from one module to another in ÃÛ¶¹ÊÓƵ Workfront Fusion.

Assets

Create an Asset

This action module creates a new asset.

Connection
For instructions on creating a connection to Frame.io, see Connect Frame.io to ÃÛ¶¹ÊÓƵ Workfront Fusion in this article.
Team ID
Select or map the team that owns the project that you want to create an asset for.
Project ID
Select the project or map the ID of the project that you want to create an asset for.
Folder ID
Select the folder or map the ID of the folder you want to create an asset in.
Type
Select whether to create a folder or file.
Name
Enter the name of the new file or folder.
Source URL
Enter the URL of the file you want to upload.
Description
Enter a brief description of the asset.

Delete an Asset

This action module deletes a specified asset.

Connection
For instructions on creating a connection to Frame.io, see Connect Frame.io to ÃÛ¶¹ÊÓƵ Workfront Fusion in this article.
Team ID
Select or map the team that owns the project that contains the asset you want to delete.
Project ID
Select the project or that contains the asset you want to delete.
Folder ID
Select the folder that contains the asset you want to delete
Asset ID
Select or map the asset you want to delete.

Get an Asset

This action module retrieves asset details.

Connection
For instructions on creating a connection to Frame.io, see Connect Frame.io to ÃÛ¶¹ÊÓƵ Workfront Fusion in this article.
Team ID
Select or map the team that owns the project that contains the asset you want to retrieve details about.
Project ID
Select the project that contains the asset you want to retrieve details about.
Folder ID
Select the folder that contains the asset you want to retrieve details about.
Asset ID
Select the asset or map the ID of the asset you want to retrieve details about.

List Assets

This search module retrieves all assets in the specified project’s folder.

Connection
For instructions on creating a connection to Frame.io, see Connect Frame.io to ÃÛ¶¹ÊÓƵ Workfront Fusion in this article.
Team ID
Select or map the team that owns the project that contains the folder you want to retrieve assets from.
Project ID
Select the project that contains the folder you want to retrieve assets from.
Folder ID
Select the folder you want to list assets from.
Limit
Set the maximum number of assets Workfront Fusion will return during one execution cycle.

Update an Asset

This action module allows you to update an existing asset’s name, description, or custom fields.

Connection
For instructions on creating a connection to Frame.io, see Connect Frame.io to ÃÛ¶¹ÊÓƵ Workfront Fusion in this article.
Team ID
Select or map the team that owns the project that you want to update an asset for.
Project ID
Select the project or map the ID of the project that you want to update an asset for.
Folder ID
Select the folder or map the ID of the folder you want to update an asset in.
Name
Enter the name of the updated file.
Description
Enter a brief description of the updated asset.

Watch Asset Deleted

This trigger module starts a scenario when an asset is deleted.

Webhook name
Enter the name of the webhook, e.g. Asset deleted.
Connection
For instructions on creating a connection to Frame.io, see Connect Frame.io to ÃÛ¶¹ÊÓƵ Workfront Fusion in this article.
Team ID
Select the team this webhook is created for.

Watch Asset Label Updated

This trigger module starts a scenario when an asset’s status is set, changed, or removed.

Webhook name
Enter the name of the webhook, e.g. Asset status updated.
Connection
For instructions on creating a connection to Frame.io, see Connect Frame.io to ÃÛ¶¹ÊÓƵ Workfront Fusion in this article.
Team ID
Select the team this webhook is created for.

Watch New Asset

This trigger module starts a scenario when a new asset is created.

Webhook name
Enter the name of the webhook, e.g. Asset created.
Connection
For instructions on creating a connection to Frame.io, see Connect Frame.io to ÃÛ¶¹ÊÓƵ Workfront Fusion in this article.
Team ID
Select the team this webhook is created for.

Comments

Create a Comment

This action module adds a new comment or reply to the asset.

Connection
For instructions on creating a connection to Frame.io, see Connect Frame.io to ÃÛ¶¹ÊÓƵ Workfront Fusion in this article.
Type
Select whether you want to create a comment or reply to a comment.
Team ID
Select or map the team that owns the project that contains the asset you want to add a comment to.
Project ID
Select the project or map the ID of the project that contains the asset you want to add a comment to.
Folder ID
Select the folder or map the ID of the folder that contains the asset you want to add a comment to.
Asset ID
Select or map the asset you want to add a comment to.
Comment ID
Select or map the comment you want to add a reply to.
Text
Enter the text content of the comment or reply.
Timestamp
Enter the frame number in the video the comment should be linked to.

Delete a Comment

This action module deletes an existing comment.

Connection
For instructions on creating a connection to Frame.io, see Connect Frame.io to ÃÛ¶¹ÊÓƵ Workfront Fusion in this article.
Team ID
Select or map the team that owns the project that contains the asset you want to delete a comment from.
Project ID
Select the project or map the ID of the project that contains the asset you want to delete a comment from.
Folder ID
Select the folder that contains the asset you want to delete a comment from.
Asset ID
Select the asset that contains the comment you want to delete.
Comment ID
Select the comment you want to delete.

Get a Comment

This action module retrieves details of the specified comment.

Connection
For instructions on creating a connection to Frame.io, see Connect Frame.io to ÃÛ¶¹ÊÓƵ Workfront Fusion in this article.
Team ID
Select or map the team that owns the project that contains the folder you want to retrieve assets from..
Project ID
Select the project that contains the folder you want to retrieve assets from.
Folder ID
Select the folder you want to list assets from.
Asset ID
Select the asset that contains the comment you want to retrieve.
Comment ID
Select the comment you want to retrieve details about.

List Comments

This search module retrieves all comments of the specified asset.

Connection
For instructions on creating a connection to Frame.io, see Connect Frame.io to ÃÛ¶¹ÊÓƵ Workfront Fusion in this article.
Team ID
Select or map the team that owns the project that contains the folder you want to retrieve comments from.
Project ID
Select the project that contains the folder you want to retrieve comments from.
Folder ID
Select the folder that contains the asset you want to list comments from.
Asset ID
Select the asset you want to list comments for.
Limit
Set the maximum number of comments Workfront Fusion will return during one execution cycle.

Update a Comment

This action module edits an existing comment.

Connection
For instructions on creating a connection to Frame.io, see Connect Frame.io to ÃÛ¶¹ÊÓƵ Workfront Fusion in this article.
Team ID
Select or map the team that owns the project that contains the asset you want to update a comment on.
Project ID
Select the project \ that contains the asset you want to update a comment on.
Folder ID
Select the folder that contains the asset you want to update a comment on.
Asset ID
Select the asset you want to update a comment on.
Comment ID
Select the comment you want to update.
Text
Enter the text content of the comment.
Timestamp
Enter the frame number in the video the comment is linked to.

Watch Comment Updated

This trigger module starts a scenario when a comment is edited.

Webhook name
Enter the name of the webhook, e.g. Comment Edited.
Connection
For instructions on creating a connection to Frame.io, see Connect Frame.io to ÃÛ¶¹ÊÓƵ Workfront Fusion in this article.
Team ID
Select the team this webhook is created for.

Watch New Comment

This trigger module starts a scenario when a new comment or reply is created.

Webhook name
Enter the name of the webhook, e.g. New Comment.
Connection
For instructions on creating a connection to Frame.io, see Connect Frame.io to ÃÛ¶¹ÊÓƵ Workfront Fusion in this article.
Team ID
Select the team this webhook is created for.

Projects

List Projects

This search module retrieves all projects for the specified team.

Connection
For instructions on creating a connection to Frame.io, see Connect Frame.io to ÃÛ¶¹ÊÓƵ Workfront Fusion in this article.
Team ID
Select or map the team you want to retrieve projects for.
Limit
Set the maximum number of projects Workfront Fusion will return during one execution cycle.

Other

Make an API Call

This module allows you to perform a custom API call.

Connection
For instructions on creating a connection to Frame.io, see Connect Frame.io to ÃÛ¶¹ÊÓƵ Workfront Fusion in this article.
URL

Enter a path relative to https://api.frame.io. Example: /v2/teams

Note: For the list of available endpoints, refer to the Frame.io API Reference.

Method
Select the HTTP request method you need to configure the API call. For more information, see HTTP request methods in ÃÛ¶¹ÊÓƵ Workfront Fusion.
Headers

Add the headers of the request in the form of a standard JSON object.

For example, {"Content-type":"application/json"}

Workfront Fusion adds authorization headers automatically.

Query String
Enter the request query string. For each parameter that you want to include in the query string, click Add item and enter the field's name and the desired value.
Body

Add the body content for the API call in the form of a standard JSON object.

Note:

When using conditional statements such as if in your JSON, put the quotation marks outside of the conditional statement.

Example: The following API call returns all teams and its details in your Frame.io account:

URL: /v2/teams

Method: GET

The result can be found in the module’s Output under Bundle > Body.

In our example, the details of 1 team were returned:

recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43