How-toFor engineers
Create an action
Define a custom action — its metadata, how a care flow author configures it in Studio, and the logic that runs when a care flow activates it.
An action is where an extension does something. The action code defines:
- Basic metadata such as the title, icon and category.
- How the care flow author configures it, through action fields.
- The logic that runs when the action is activated in a care flow, in
onEvent.
Title and category decide how the action appears in Studio
Start the title with a verb
By convention, an action title starts with a verb: send SMS, schedule appointment, generate random number.
In Studio an author picks from a list of actions, and verbs make that list read as things to do.
The category decides where the author finds it
Actions are grouped by category in Studio, and the category must be one of the predefined ones.
Next steps
Next: Action fields to define what the author configures.