ÃÛ¶¹ÊÓÆµ

Frame.io Beta (V4) modules

IMPORTANT
This article describes the new (beta) version of the Frame.io connector. This connector is used to connect to Frame.io version 4.
For instructions on the legacy version of the Frame.io connector, see Frame.io Legacy connector.

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

Workfront offers two Frame.io connectors, based on the version of Frame.io that you are connecting to.

Connector
Frame.io version
Frame.io (Beta)
V4
Frame.io (Legacy)
V3

For instructions on the legacy version of the Frame.io connector, see Frame.io Legacy connector.

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

Access requirements

Expand to view access requirements for the functionality in this article.

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

table 0-row-2 1-row-2 2-row-2 3-row-2 layout-auto html-authored no-header
ÃÛ¶¹ÊÓÆµ Workfront package Any
ÃÛ¶¹ÊÓÆµ Workfront license

New: Standard

Or

Current: Work or higher

ÃÛ¶¹ÊÓÆµ Workfront Fusion license**

Current: No Workfront Fusion license requirement

Or

Legacy: Workfront Fusion for Work Automation and Integration

Product

New:

  • Select or Prime Workfront package: Your organization must purchase ÃÛ¶¹ÊÓÆµ Workfront Fusion.
  • Ultimate Workfront package: Workfront Fusion is included.

Or

Current: Your organization must purchase ÃÛ¶¹ÊÓÆµ Workfront Fusion.

For more detail about the information in this table, see Access requirements in documentation.

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

The connection process differs based on whether you are using the Legacy Frame.io connector or the Beta Frame.io connector.

  1. In any Frame.io Beta module, click Add next to the Connection box.

  2. Fill in the following fields:

    table 0-row-2 1-row-2 2-row-2 3-row-2 layout-auto html-authored no-header
    Connection type Select whether you want to create an IMD User authentication connection or an IMS Server to Server connection.
    Connection name Enter a name for this connection.
    Client ID

    Enter your ÃÛ¶¹ÊÓÆµ Client ID. This can be found in the Credentials details section of the ÃÛ¶¹ÊÓÆµ Developer Console.

    For instructions locating credentials, see in the ÃÛ¶¹ÊÓÆµ developer documentation.

    Client Secret

    Enter your ÃÛ¶¹ÊÓÆµ Client Secret. This can be found in the Credentials details section of the ÃÛ¶¹ÊÓÆµ Developer Console.

    For instructions locating credentials, see in the ÃÛ¶¹ÊÓÆµ developer documentation.

  3. Click Continue to save the connection and return to 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.

Map toggle

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.
Account ID
Select the account or map the ID of the account that contains the project that you want to create an asset for.
Workspace ID
Select the workspace or map the ID of the workspace that contains 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.
Path
Select the path where you want to create an asset.
File Name
Enter the name of the file that you want to use for this asset.
File Size
Enter or map the file size in bytes.
Source URL
If creating a file, enter the URL of the file you want to upload.
Media type
Select the media type for this 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.
Account ID
Select the account or map the ID of the account that contains the asset that 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.
Account ID
Select the account or map the ID of the account that contains the asset that you want to retrieve.
Asset ID
Select or map the asset you want to retrieve.

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.
Account ID
Select the account or map the ID of the account that contains the assets that you want to list.
Maximum number of returned assets
Enter or map the maximum number of assets you want the module to return during each scenario execution cycle.

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.
Account ID
Select the account or map the ID of the account that contains the asset you want to add a comment to.
Workspace ID
Select the account or map the ID of the workspace 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.
Path
Select the path to the asset that you want to add a comment 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.
Page
If the asset is a PDF, enter or map the page that the comment should be attached 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.
Account ID
Select the account or map the ID of the account that contains comment that you want to delete.
Comment ID
Enter or map the ID of 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.
Account ID
Select the account or map the ID of the account that contains comment that you want to retrieve details about.
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.
Account ID
Select or map the account that contains the asset that you want to retrieve comments from.
Workspace ID
Select or map the workspace that contains the asset that you want to retrieve comments from.
Project ID
Select the project that contains the asset you want to retrieve comments from.
Path
Select the the path that leads to the asset you want to list comments from.
Maximum number of returned comments
Enter or map the maximum number of comments you want the module to return during each scenario 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.
Account ID
Select or map the account that contains the project that contains 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.
Page
If the asset is a PDF, enter or map the page that the comment is attached to.

Folders

Create a folder

This action module creates a new folder in Frame.io.

Connection
For instructions on creating a connection to Frame.io, see Connect Frame.io to ÃÛ¶¹ÊÓÆµ Workfront Fusion in this article.
Account ID
Select or map the account where you want to create a folder.
Workspace ID
Select or map the workspace where you want to create a folder.
Project ID
Select the where you want to create a folder.
Path
Select the the path where you want to create a folder.
Name
Enter or map a name for the new folder.

Projects

Create a project

This action module creates a new project in Frame.io.

Connection
For instructions on creating a connection to Frame.io, see Connect Frame.io to ÃÛ¶¹ÊÓÆµ Workfront Fusion in this article.
Account ID
Select or map the account where you want to create a project.
Workspace ID
Select or map the workspace where you want to create a project.
Name
Enter or map a name for the new project.

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.
Account ID
Select or map the account that contains the asset that you want to retrieve projects from.
Workspace ID
Select or map the workspace that contains the asset that you want to retrieve projects from.
Maximum number of returned projects
Enter or map the maximum number of projects you want the module to return during each scenario execution cycle.

Shares

This action modules adds an asset to a share link in Frame.io.

Connection
For instructions on creating a connection to Frame.io, see Connect Frame.io to ÃÛ¶¹ÊÓÆµ Workfront Fusion in this article.
Account ID
Select or map the account that contains the share link that you want to add an asset to.
Share link ID
Select or map the share link that you want to add an asset to.
Asset ID
Enter or map ID of the asset that you want to add to the share link.

This action module creates a new share link in Frame.io.

Connection
For instructions on creating a connection to Frame.io, see Connect Frame.io to ÃÛ¶¹ÊÓÆµ Workfront Fusion in this article.
Account ID
Select or map the account where you want to create a share link.
Workspace ID
Select or map the workspace where you want to create a share link.
Project ID
Select or map the project where you want to create a share link.
Access
Select whether this link has public or restricted access.
Assets
For each asset that you want to add to the share link, click Add item and enter the asset's ID.
Description
Enter or map a description for the share link.
Name
Enter or map the expiration date for the share link.
Name
Enter or map a name for the new share link.
Name
Enter or map a passphrase for the share link.

Workspaces

Create a workspace

This action module creates a new workspace in Frame.io

Connection
For instructions on creating a connection to Frame.io, see Connect Frame.io to ÃÛ¶¹ÊÓÆµ Workfront Fusion in this article.
Account ID
Select or map the account where you want to create a workspace.
Name
Enter or map a new name for the workspace.

List workspaces

This module lists all workspaces in an account.

Connection
For instructions on creating a connection to Frame.io, see Connect Frame.io to ÃÛ¶¹ÊÓÆµ Workfront Fusion in this article.
Account ID
Select or map the account that contains the asset that you want to retrieve workspaces from.
Maximum number of returned workspaces
Enter or map the maximum number of workspaces you want the module to return during each scenario execution cycle.

Other

Make a custom 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: /v4/me

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.
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.

recommendation-more-help
7e1891ad-4d59-4355-88ab-a2e62ed7d1a3