Overview
You can see plenty of fully working examples at our GitHub repo.
Keep Workflow Engine designed to streamline and automate operational tasks by integrating triggers, steps, actions, and conditions. This documentation provides an overview of the core concepts used to define and execute workflows effectively.
General Structure
Each workflow compose of:
- metadata - id, description
- triggers - when this workflow runs?
- steps/actions - what this workflow should do?
The general structure of a workflow is:
Let’s dive into building workflows:
- Triggers
- Steps And Actions
- Conditions
- Functions
- Context
- Providers
- Variables
- Foreach Loops
- Alert Enrichment
Triggers
Define how a workflow starts, such as manually, on a schedule, or in response to alerts with optional filters for specific conditions.
Steps And Actions
Represent sequential operations, like querying data or running scripts, using configurable providers.
Conditions
Allow decision-making in actions based on thresholds, assertions, or previous step results.
Functions
Built-in helpers like datetime_compare or is_business_hours simplify complex operations.
Context
Enables access to and reuse of outputs from earlier steps within actions or conditions.
Providers
External systems or services (e.g., Slack, Datadog, ServiceNow) integrated into workflows through a standard configuration interface.
Foreach Loops
Iterate over a list of results from a step to perform repeated actions for each item.
Alert Enrichment
Add context to alerts, like customer details or ticket metadata, using enrichment mechanisms in steps or actions.