A custom action plugin is a plugin that can be associated to a custom action node in an automation, allowing you to trigger a custom action in an automation.
This feature is useful for triggering actions not available in the current list of actions in automations.
Get the properties associated with the custom action plugin instance.
Path Parameters
Name
Type
Description
Creating a custom action plugin
See the documentation to see .
A custom action plugin has the SCENARIO_CUSTOM_ACTION plugin type. Its group id should be {domain.organisation.scenario-custom-action} (for example com.mediarithmics.scenario-custom-action).
Its artifact id should be the name of the custom action plugin, i.e. example-custom-action.
Use our to create your custom action plugin in Node.js: the required routes are already defined and you only have to override specific functions.
You can find a sample custom action plugin .
We can provide you with a Hello World project using our SDK. Please contact your support to gain access to it.
The project structure and files work as .
Interfaces to implement
You should extend CustomActionBasePlugin class and implement the onCustomActionCall function from the plugin SDK.
The onCustomActionCall function is called every time a UserPoint runs through a custom action node in an automation. It is responsible for implementing the custom action.
Don't forget to catch your errors. You should log / respond with the appropriate message to facilitate debugging.
Use this method to create a custom action plugin instance attached to an organisation. This will display the custom action as a choice in the custom action automation node.