- Documentation
- Integrations
- Apps
- Iconik integration
Iconik integration
Automate a client Iconik media library — search assets, drive metadata, manage collections, and react to library changes in real time.
What it does
The Iconik integration lets your agency drive a client media asset manager from inside any workflow. Connect once with the client App-ID and Auth-Token, and your workflows can search the catalog, read and write metadata, build and reorganize collections, manage permissions and shares, and pull download URLs for proxies and masters.
It also listens. Iconik pushes real-time notifications for asset and collection lifecycle events, so a workflow can start the moment an editor uploads footage, changes metadata, or adds a clip to a review collection — no polling, and no scheduled scan.
Connect an Iconik account
- Open the workflow editor, add an Iconik node, and choose Add connection on the node.
- In a new tab, sign in to the client Iconik account and open Admin → App Tokens.
- Create an App Token scoped to the smallest set of permissions the workflow needs, then copy both the App-ID and the Auth-Token.
- Paste both values into TaskJuice and save the connection.
An App Token inherits the permissions of the user who created it, so create it as an administrator if your workflows need to reach users, permissions, or webhook settings.
To rotate or revoke access later, return to Admin → App Tokens, delete the entry, create a new token, and update the TaskJuice connection.
Triggers
Iconik triggers are provisioned automatically. When you publish a workflow, TaskJuice registers the matching notification with Iconik and tears it down when the workflow is unpublished — there is nothing to configure in the Iconik admin UI.
- New Asset — Triggers when an asset is created in Iconik.
- Asset Updated — Triggers when an asset entity is updated in Iconik.
- Asset Deleted — Triggers when an asset is deleted in Iconik.
- Asset Metadata Updated — Triggers when metadata values on an asset change.
- Asset Permissions Changed — Triggers when an access-control entry is added to an asset.
- New Collection — Triggers when a collection is created in Iconik.
- Collection Updated — Triggers when a collection entity is updated in Iconik.
- Collection Deleted — Triggers when a collection is deleted in Iconik.
- Asset Added to Collection — Triggers when an object is added to a collection.
- Asset Removed from Collection — Triggers when an object is removed from a collection.
- Collection Permissions Changed — Triggers when an access-control entry is added to a collection.
Every trigger delivers the changed object under data, alongside object_id, the user_id who caused the change, and the realm/operation pair Iconik used to classify it. Delete events are the exception: Iconik sends an empty data object, so use object_id to identify what was removed.
Actions
Assets
- List Assets — Get list of assets.
- Create Asset — Create a new asset.
- Get Asset — Returns a particular asset by id.
- Update Asset — Update asset.
- Delete Asset — Delete a particular asset by id.
- Purge Asset — Purges a particular asset by id immediately.
- Restore Asset — Restore deleted asset by id.
- List Recently Viewed Assets — Get list of recently viewed assets.
- List Asset History — Get list of history entities for asset.
- Create Asset History Entry — Create an asset history entity.
- List Asset Relations — Returns an assets relations.
- Create Asset Relation — Create a new asset relation.
- List Asset Relation Types — Create a new asset relation type.
- Add Asset Version — Add asset version.
- Promote Asset Version — Promote a particular asset version to a latest version.
- Delete Asset Version — Delete a particular asset version by id.
- List Asset Segments — List of segments.
- Create Asset Segment — Create a new segment.
- Update Asset Segment — Update segment.
- Delete Asset Segment — Delete a particular segment from an asset by id.
- Export Asset Segments as WebVTT — List of segments as WebVTT file.
- Export Asset Segments as SRT — List of segments as SRT file.
- List Favorites — Get list of favorite objects.
- Add Favorites — Adds multiple objects to a list of favorites.
- Remove Favorites — Deletes objects items from a list of favorites.
- List Custom Actions — Get list of custom actions by context.
- Search Assets — Search.
- List Asset Files — Get all asset's files.
- List Asset Formats — Get all asset's formats.
- List Asset Proxies — Get all asset's proxies.
- List Asset Keyframes — Get all asset's keyframes.
- List Asset Subtitles — Get all asset's subtitles.
- Export Asset to Location — Export asset to export location.
- Analyze Asset — Start a job that sends an asset for analysis.
- Transcribe Asset — Start a job that sends an asset to default transcription service.
- Analyze Asset with Profile — Start a job that sends an asset for analysis with a custom analysis profile.
Collections
- List Collections — Get list of collections.
- Create Collection — Create a new collection.
- Get Collection — Returns a particular collection by id.
- Update Collection — Update collection.
- Delete Collection — Delete a particular collection by id.
- List Collection Contents — Returns contents of a collection by id.
- Add Object to Collection — Add an object to a collection.
- Remove Object from Collection — Delete a particular content object in a collection by id.
- List Collection Ancestors — Returns list of ancestors of a collection.
- Get Collection Full Path — Gets the full path of the collection.
- Get Collection Size — Returns the size of all the collection's assets in bytes.
- Get Collection Content Info — Get aggregated information about collection.
- Copy Collection — Copy a collection (recursively) in to another collection.
- Restore Collection — Restore deleted collection by id.
Metadata
- Get Object Metadata — Get object metadata by object type and object ID.
- Set Object Metadata — Edit metadata values directly without a view. Admin access required.
- List Metadata Fields — List the fields defined in the system.
- Create Metadata Field — Create a new field.
- Get Metadata Field — Returns a particular field by name.
- Update Metadata Field — Update field by name.
- Delete Metadata Field — Delete a particular field by name.
- List Metadata Views — List the views defined in the system.
- Create Metadata View — Create a new view.
- Get Metadata View — Returns a particular view by id.
- Get Object Metadata by View — Get object metadata by object type, object ID and view ID.
- Set Object Metadata by View — Edit view metadata values for a single object.
- Delete Metadata View — Delete a particular view by id.
Search
- List Saved Searches — Returns list of saved searches.
- Create Saved Search — Search, save and return result of this search.
- Get Saved Search — Returns results of saved search.
- Update Saved Search — Search and save this search.
- Delete Saved Search — Delete a saved search by its id.
Files, formats and media
- Get File Download URL — Get asset's file download URL.
- Get Proxy Download URL — Get asset's proxy download url.
- List Storages — Get all storages.
- List Export Locations — Get all export_locations.
- Generate Proxy and Keyframes — Create a transcode job for proxy and keyframes.
- Extract Media Info — Create a job for extracting mediainfo.
Jobs
- List Jobs — Get list of jobs.
- Get Job — Returns a particular job by id.
- Update Job — Update job.
Permissions and sharing
- Get Approval Status — Returns an objects approval request.
- Set Approval Status — Adds the approval by user and returns an objects approval status.
- Request Approval — Creates an objects approval request.
- Create Share — Create a new share.
- List Object Shares — Get list of object shares.
- Delete Share — Delete a particular share by id.
- List ACL Templates — Retreive all acl templates.
- List Object Permissions — List of object permissions.
- Set User Permissions on Object — Update or create user acl for an object.
- Set Group Permissions on Object — Update or create group acl for an object.
- Remove User Permissions on Object — Delete a user acl for an object.
- Apply ACL Template to Object — Apply template permissions to an object.
Users, groups and teams
- List Users — List of users with details.
- Get User — Returns a particular user by id.
- Get Current User — Returns current user.
- List Groups — List groups with details.
- Create User — Create a new user.
- Request User Invite Link — Request an invite link for user invitation.
- Add User to Group — Add user into a group.
- Remove User from Group — Delete a user from group.
- Get User Roles — Returns user roles by user_id.
- List Teams — List teams with details.
Automations and webhooks
- List Automations — List of automations.
- Get Automation — Returns a particular automation by id.
- List Webhooks — Get all webhooks.
- Create Webhook — Create a new webhook.
- Get Webhook — Get a webhook definition.
- Update Webhook — Update a webhook.
- Delete Webhook — Delete a webhook.
Known limitations
- Media upload is not available as an action. Iconik ingests bytes through a multipart or pre-signed S3 handshake that the declarative HTTP envelope cannot express. Workflows can create the asset record, read files, and fetch download URLs, but the upload itself must happen in Iconik, the Iconik Agent, or a connected storage.
- AI and transcode actions consume credits. Analyze Asset, Transcribe Asset, Generate Proxy and Keyframes, and Extract Media Info all queue billable jobs on pay-as-you-go plans. They return a job handle immediately; poll Get Job for completion.
- An App Token cannot exceed its creator permissions. Actions touching users, groups, permissions or webhooks require a token created by an administrator.
- A failed delivery is silent. Iconik marks a webhook
FAILINGonly on a connection-level error; an HTTP error status from the receiver leaves itENABLEDwith no recorded error, so events are dropped without a signal at the provider. - Permissions are evaluated per object. A search or list action returns only what the connected token can see, so results may differ between connections on the same domain.