How to Create and Maintain an Action in ActionJail (Administrator)

ActionJail allows you to quickly add your own logic without developing the platform core. This instruction will help you create a new action, edit it, clone or delete it, as well as organize the config and parameter input form.

When It Will Be Useful

  • You need to add a business rule or integration without changing the main code.
  • You need to update the logic of an existing action after a process change.
  • There is a typical action that is faster to copy and adapt.

What's Important to Know

  • Action — a JS script with its own system ID (action_*), configuration, and UI schema for parameters.
  • Action wizard — 5 steps: Information → Code → JSON config → UI schema → Documentation.
  • System ID — does not change after creation; used in scenarios.

Before You Start

  • You have a role with access to Apps → ActionJail.
  • You have a description of the action logic and required parameters at hand.
  • It is determined who will use the action in scenarios (for name and description).

Step-by-Step Instructions

  1. Open Apps → ActionJail and click Add new action — the wizard opens.
  2. Action Information: specify the display name, check the system ID (action_*), add a short description of the purpose.
  3. Code: paste or write JS logic; if needed, use AI generation for a draft.
  4. JSON config: set launch parameters (keys, default values) so scenarios can pass data.
  5. UI schema: add input fields (name, type, required, hint, default); this is what scenario users see.
  6. Documentation: briefly describe what the action does, what parameters it expects, and a launch example.
  7. Click Complete — the action appears in the list. For edits, open the action from the list, change fields, and click Save.
  8. To clone, select an action → Make a copy — check the new system ID and save.
  9. To delete, select an action → Delete action → confirm.

What Happens After

  • A new or updated action is available in the list and can be used in scenarios.
  • A clone is created with a new system ID, the original is not changed.

How to Verify Everything Worked

  • The action is displayed in the library and opens without errors.
  • The system ID is unique and does not change during editing.
  • UI schema fields are visible in the action parameter form in the scenario.

Other Ways

  • Cloning instead of creating from scratch — faster for similar actions.
  • AI generation of code/config/documentation — for drafts, but check manually.