Custom Actions
A custom action is like a manually triggered webhook. Instead of, as a webhook, being triggered on an event when the specified action happens in iconik, the custom actions let you trigger a manual call from within the iconik GUI and then calls the configured server. The custom action will have the icon:
Create a Custom Action
- Click on ADMIN in the top navigation.
- Choose Settings from the left navigation bar.
- Choose Custom Actions from the menu that appears from under the Settings icon.
- On the top of the list:
- Select the title for the custom action.
- Select from what context the trigger can be called.
- Asset - lets you manually trigger an asset from the asset's page or the search page.
- Collection - lets you manually trigger a collection from the collection's page or the search page.
- Bulk - lets you manually trigger multiple marked entities from the search page.
- Saved Search - lets you manually trigger multiple marked entities from saved searches.
- Shared Asset - trigger from page a user gets when visiting an asset share.
- Shared Collection - trigger from page a user gets when visiting an collection share.
- Select what call will be made, POST or Open.
- Add the URL which the custom action shall POST a message to.
- If you want headers sent you can define the header, and the value. Click + ADD. Headers can only be added to custom actions of type POST.
- You may choose to add a metadata view that can be filled in when the custom action is triggered.
- Choose the App name from the list of Application Tokens
- Click + ADD to add the action.
Trigger a Custom Action.
It is possible to trigger a custom action from the entity's page or the search page.
Entities
From the entity's page
Go to the Entity's page then:
- In the upper right corner click on the gear.
- The custom actions which have the correct context will be visible in the dropdown list.
- Click on the custom action which you want to trigger.
- If a metadata view is linked to the custom action a window with the metadata view will appear, fill it in and click SUBMIT.
From the search page
Go to the Search page then:
- Right click on the entity which you want to trigger.
- The custom actions which have the correct context will be visible in the dropdown list.
- Click on the custom action which you want to trigger.
- If a metadata view is linked to the custom action a window with the metadata view will appear, fill it in and click SUBMIT.
Bulk
To trigger a bulk go to the search page then:
- Mark multiple entities from the search page.
- Right click on one of the marked entities.
- The custom actions which have the Bulk context will be visible in the dropdown list.
- Click on the custom action which you want to trigger.
- If a metadata view is linked to the custom action a window with the metadata view will appear, fill it in and click SUBMIT.
Update a Custom Action
On the Admin page:
- Choose Settings from the left navigation bar.
- Choose Custom Action from the menu that appears from under the Settings icon.
- Right-click on the custom action you wish to update
- Select Edit Custom Action.
- Edit the fields.
- Click to update the custom action.
Delete a Custom Action
On the Admin page:
- Choose Settings from the left navigation bar.
- Choose Custom Actions from the menu that appears from under the Settings icon.
- Find the custom action in the list which you wish to delete.
- Right-click on the custom action you wish to delete.
- Select Delete Custom Action.
- Confirm by clicking
Custom POST Action technical details.
The custom action that is POSTed to the URL that you specified will send a JSON payload, with the following information:
- 'user_id': User who has invoked the action
- 'systemdomainid': Your System Domain ID
- 'context': context: Context in the system.
- 'action_id': The UUID of the actions
- 'asset_ids': A list of asset IDs
- 'collection_ids': A list of collection IDs
- 'savedsearchids': A list of Saved Search IDs
- 'metadata_values': Metadata values
- 'date_created': Date Stamp