frame.io header image

Introduction

A seamless experience bridging the functionality between frame.io and iconik.

Features

The iconik-2-frame.io integration has two unique features each with their own associated functionality for their given use cases. These features are Project Archive and Review and Approve.

Project Archive

The Project Archive service allows a project to be archived from FrameIO into iconik. This feature can be used when a end user wants to completely migrate their frame.io project back to iconik completely preserving the projects metadata, comments, annotation and version information.

Review and Approve

The Review and Approve feature allows a user to send an iconik asset to frame.io selecting the end users they want to receive the review invitation, add a description, set the expiration date and determine whether it is the proxy or master file that gets sent. Upon receipt in frame.io the received file will have a Watermark applied to it. Any comments and annotations that a user creates in frame.io will be dynamically sent back to iconik.

Setup

The following sections details the steps required to ensure the successful setup of frame.io for use with our integrations.

frame.io

base does not manage frame.io accounts on behalf of a customer as such this set up assumes the customer has a FrameIO account and the relevant configuration in place such as a Team within the account.

Authentication Token

The customer must create an authentication token following the guide: Authentication

Webhook

The customer must create a webhook with the URL and tenant-id supplied by the Cloud Support Engineer during your onboarding.

Webhook URL
URL: app.base-foundation.io/api/v1/services/frameio/archive/webhooks/project-updated?tenant-id={tenant-id}

Example

app.base-foundation.io/api/v1/services/frameio/archive/webhooks/project-updated?tenant-id=0419e0c5-6fed-4b66-bf0f-f8a99d44bcd0

Only project.updated must be selected from Projects events. Fir further info, see the official documentation from frame.io on Webhooks

frame.io header image
Image 1 - Webhook Setup

References