In this guide we will help you configure webhooks to automate workflows based on activity in your Frame.io workspace. Webhooks send information to a URL you configure whenever something happens in Frame.io, so your automation tool can act on it. Let's get started.
If you want to learn more about webhooks and how they work, check out our webhooks documentation.
Webhooks fire automatically based on events in your workspace. Unlike Actions, which require a user to manually trigger them, webhooks run in the background without any user interaction.
Note: Webhooks are currently in beta.
What you'll need
A Frame.io V4 account with Account Admin permissions
A receiving URL from your automation tool (for Zapier, this comes from the trigger step of your Zap)
Before you start
Who can create webhooks: Account Admins only.
Event scope: All events are scoped to the workspace you select. Events fire for activity across all projects in that workspace.
Migration note: Webhooks from legacy Frame.io accounts are automatically disabled on migration to V4. Re-enable them from the webhooks settings page after confirming your configuration is compatible.
Create a webhook
Click Create Webhook
Fill in the fields:
Name: A descriptive label for this webhook, for example: *File Ready Notifications*
URL: The receiving URL from your automation tool
Workspace: The workspace this webhook will monitor
Events: The events you want this webhook to fire on (see below)
Click Save
Note: A single webhook can subscribe to multiple events. For example, you can configure one webhook to fire on both `file.ready` and `file.copied` so your automation handles multiple trigger points without needing separate webhooks.
Tip: Subscribe to as few events as needed. A focused webhook is easier to manage and reduces unnecessary processing on the receiving end.
Available events
Choose the events that match your workflow. Webhooks can subscribe to one or many events.
Projects
Webhook | Description |
project.created | a new project is created |
project.updated | a project's settings change |
project.deleted | a project is deleted |
Files
Webhook | Description |
file.created | a file is created |
file.ready | a file has finished uploading and all transcodes are complete |
file.updated | a file's name or other details change |
file.deleted | a file is deleted |
file.upload.completed | a file upload completes |
file.versioned | a new file version is created |
file.copied | a file is copied |
Folders
Webhook | Description |
folder.created | a new folder is created |
folder.updated | a folder's settings change |
folder.deleted | a folder is deleted |
folder.copied | a folder is copied |
Comments
Webhook | Description |
comment.created | a new comment or reply is created |
comment.updated | a comment is updated |
comment.deleted | a comment is deleted |
comment.completed | a comment is marked as completed |
comment.uncompleted | a comment is marked as uncompleted |
Metadata
Webhook | Description |
metadata.value.updated | a metadata field is updated on an asset |
Collections
Webhook | Description |
collection.created | a new collection is created |
collection.updated | a collection is updated |
collection.deleted | a collection is deleted |
Shares
Webhook | Description |
share.created | a new share is created |
share.updated | a share is updated |
share.deleted | a share is deleted |
share.viewed | a share is viewed |
What the payload contains
When a webhook fires, Frame.io sends the following data to your URL:
Field | Description |
type | The event that occurred, for example: file.ready |
account | The Frame.io account associated with the webhook |
workspace | The workspace where the event occurred |
project | The project containing the resource |
resource.id | The ID of the file, folder, or other resource that triggered the event |
resource.type | The type of resource, for example: file, folder, comment |
user | The user who performed the action |
Note: The payload contains only the resource ID, not full resource details. If your workflow needs additional information about the asset, your automation tool will need to make a follow-up API call to Frame.io using the resource ID.
Manage webhooks
Go to next.frame.io/settings/webhooks to view, edit, enable, or disable webhooks. Any Account Admin can create, modify, or delete them.
Troubleshooting
Webhook is not firing
Confirm the webhook is active in your settings and that the events you subscribed to match the actions you are performing in Frame.io.
Receiving the wrong events
Check your event subscriptions and remove any events your workflow does not need. If you are monitoring a specific folder, add a filter step in your automation tool to scope the webhook to the right project or folder.
Webhook stopped working after migration
Go to next.frame.io/settings/webhooks, check the status of your webhooks, and re-enable any that were disabled during migration to V4.
No access to webhook settings
Creating and managing webhooks requires Account Admin permissions. Contact your Account Admin.