Automations

The Automations module allows configuring rules that execute actions under defined conditions. The route is /manage-automations/automations.

Key concepts

• Automation rule (AutomationRule): a rule that has a name, action key, webhook URL, associated service, selected fields and status.
• Action key: key of the system action that triggers the rule.
• Webhook URL: endpoint to which the request will be sent when the rule fires.
• Service: system service associated with the rule (for example, a specific schedule service).
• Selected fields: subset of event fields that are sent to the webhook.
• Status: active or inactive.

How the screen is organized

Table with the list of rules. Above the table there is a toolbar with search and high and bulk delete buttons. Actions per row: edit, delete, status toggle.

Available actions

• Create rule: high dialog with name, action key, webhook URL, service, fields, status.
• Edit rule: adjust data.
• Activate or deactivate: the rule stops executing when the event is triggered.
• Delete: requires AUTOMATIONS: ADMIN.

Roles and permissions

• AUTOMATIONS: WRITE to create, edit and change status.
• AUTOMATIONS: ADMIN to delete.

Documented features

Feature	Page
Create automation	Create automation
Edit automation	Edit automation
Activate or deactivate automation	Activate or deactivate automation

Relation with other modules

• Notifications: automation rules can use the notification system as destination.
• Services: each rule can be associated with a specific service from the catalog.
• Audit log: the firings of the rules and their results are recorded.

Operational recommendations

• Document the webhook URL, its purpose and its responsible person.
• Validate the webhook in a test environment before activating in production.
• Keep the selectedFields field reduced to what is necessary to avoid large payloads.
• Periodically audit the active rules to ensure they are still valid.