Iconik Integration
Iconik is a cloud-native Media Asset Management system that securely gathers and organises media from any storage location. Closed Caption Creator offers two pre-built integration options for Iconik, each suited to a different operational model. Both can be deployed independently or together depending on your workflow requirements.
In the round-trip model, editors can also publish marker metadata as Iconik timed segments, request an Iconik review/approval after publish, and view or update Iconik asset metadata without leaving Closed Caption Creator.
Integration Models​
The first option is the registration model, which is designed for teams where the captioning work is performed by an external party that does not have direct access to Iconik. An Iconik user sends an asset to Closed Caption Creator with a single click, and the resulting project appears in a pre-configured storage folder inside Closed Caption Creator. The captioning team can then open and work on the project without needing Iconik credentials. This model is well suited to organisations where a marketing or production team manages assets in Iconik and routes captioning work to an external supplier.
The second option is the round-trip model, which is intended for users who have direct access to Iconik. An editor opens any video asset in Iconik, clicks Edit Captions from the asset menu, and the project opens directly in Closed Caption Creator — including the video and any existing subtitle tracks. Once editing is complete, the editor clicks the Publish button in the top-right toolbar to send the finished subtitle files back to Iconik. Systems can be configured with one or both integration models as required.
Configuring the Integration​
Integration credentials are managed in Edit > Options, under the Integrations tab. In the Iconik section, enter your Iconik App ID and Iconik Auth Token and click Save Settings. These credentials authenticate all communication between Closed Caption Creator and your Iconik system and must be valid before any import, publish, metadata, or review actions will succeed. If you are unsure where to find your credentials, contact your Iconik system administrator.
Your Iconik App ID and Auth Token must have permission to read and write subtitle files for the target storage, create and update segments (for marker publish), create approval requests (for review after publish), and read/write metadata views you intend to edit. If a specific action fails while others succeed, the token roles for that action are the first place to check.
Importing Assets​
When an asset is registered or opened from Iconik, the Iconik Import process runs automatically. Closed Caption Creator connects to your Iconik system, retrieves the asset and its associated caption files, and loads the project. The video and all available subtitle tracks are imported and made available for editing in the standard project workspace. No manual file download is required.
Retrieving Proxy Files​
In some configurations the primary media file may not be directly accessible from the browser. When this occurs, Closed Caption Creator can retrieve the proxy file associated with the asset from Iconik. Use the reload-proxy control in the toolbar while an Iconik asset is open. The proxy retrieval process connects to Iconik, obtains the proxy URL, and loads the video into the player automatically.
Publishing Back to Iconik​
When editing is complete, clicking the Publish button opens the Iconik Publish panel. From here you select the Storage Location where the subtitle file should be delivered within Iconik, choose the Subtitle Format for the output (such as WebVTT or SRT), set the Language Code for each track, mark tracks as closed captions if needed, choose which tracks to publish, and optionally enable Overwrite to replace an existing Iconik subtitle for that track.
Use Publish All, CC All, and Overwrite All to toggle those columns for every Event Group at once.
Once the configuration is confirmed, click Publish Now. The publish workflow encodes the selected subtitle tracks and delivers them directly to your Iconik storage. A success notification confirms delivery, and the files will be visible in the asset's Files panel in Iconik.
You must select at least one action before publishing: one or more subtitle tracks, Publish marker metadata, Request review after publish, or any combination of those.
Publish marker metadata​
Enable Publish marker metadata in the Iconik Publish panel to send the project's marker lists to Iconik as time-based MARKER segments.
Closed Caption Creator maps each marker as follows:
- Marker time (and end time when present) become the segment in and out points
- Marker comment becomes the segment text
- Marker list name and colour are stored on the segment track and colour fields
Only markers previously published by Closed Caption Creator are replaced. Those segments are identified by an ccc: external ID, so markers created directly in Iconik are left alone. Publishing markers again on the same asset replaces the previous CCC-owned set with the current lists.
Marker publish can run on its own or together with subtitle publish. If subtitles succeed but marker publish fails, Closed Caption Creator shows a warning so you can retry markers without redoing the whole subtitle delivery. For more on creating and organising markers in the editor, see Markers.
Request review after publish​
Enable Request review after publish to create an Iconik approval request after the selected publish steps complete successfully. This is useful when another team member needs to review newly published subtitles in Iconik before the asset moves to the next production step.
When the option is enabled, the Publish panel shows:
- Reviewers (users) — multi-select list of Iconik users available to your account
- Reviewers (groups) — multi-select list of Iconik groups
- External reviewer emails — optional comma-separated email addresses for external reviewers
- Minimum approvals — how many approvals are required before the asset is considered approved (default is 1)
Reviewers are loaded from Iconik when the Publish panel opens. If the reviewer list cannot be loaded, you can still request review without selecting users. Review request is a post-action: subtitle and/or marker publish run first, then the approval request is created. If the review request fails after a successful publish, Closed Caption Creator reports a partial-success warning.
For how Iconik handles approval workflows on the asset, see Iconik's Review and Approve overview.
Viewing and Updating Asset Metadata​
While an Iconik asset is open in the round-trip model, the toolbar includes a metadata control next to Publish. Click it to open the Iconik Asset Metadata panel.
- Choose a Metadata View from the dropdown. Views come from your Iconik domain (typically the default asset category views).
- Field values for that view are loaded from the current Iconik asset.
- Edit supported fields. Tag-style fields accept comma-separated values. Read-only fields are labelled and cannot be changed.
- Click Save Metadata to write the updated values back to Iconik.
This panel is separate from Closed Caption Creator's local project metadata under Edit > Options. Local project metadata is stored with your CCC project file; Iconik Asset Metadata reads and writes the asset's metadata in Iconik itself.
If no views appear, confirm that your Iconik credentials are valid and that your account can read metadata views for assets. If save fails, confirm write permission for the selected view.
Troubleshooting​
If an import fails with an authentication or missing asset error, re-check that the Iconik App ID and Iconik Auth Token entered in Edit > Options > Integrations are correct and have not expired. Also confirm that the asset identifier is still valid in Iconik and that your account has the necessary access permissions.
If proxy retrieval fails or the video does not load after import, retry the proxy retrieval process and verify that the asset has an active proxy record in Iconik. In some cases the proxy may not yet have been generated; confirm the asset status in Iconik before retrying.
If a publish operation completes but the expected subtitle file does not appear in Iconik, verify that the correct Storage Location was selected in the Iconik Publish panel and that your account has write permissions for that storage. Re-running the publish after confirming track configuration will resolve most delivery failures.
If marker publish fails, confirm your Iconik token includes segment create and delete permissions (can_create_segments and related roles) and that the asset supports time-based metadata / segments.
If an approval request fails, confirm the token has can_write_approval_request and that selected reviewers are valid Iconik users or groups. External emails must be valid addresses.
If the Iconik Asset Metadata panel cannot load views or save fields, confirm metadata read/write access for the selected view and that the view is assigned to assets in your Iconik domain.
For low-level API behaviour, Iconik publishes interactive specs at the Iconik Swagger definitions page (assets/ for approvals and segments, metadata/ for views and asset field values).
Video Tutorials​
The following videos cover the full Iconik integration workflow, from initial setup through to subtitle editing and publishing.