Workflows
Configure a predefined set of actions to automate responses to incidents.
Last updated
Configure a predefined set of actions to automate responses to incidents.
Last updated
A Workflow represents a predefined series of actions initiated by specific conditions. These Workflows are instrumental in automating responses to various incidents. For example, you can establish a Workflow for addressing P1/P2 incidents and another for managing security incidents.
Note: This feature will be available in the Premium and Enterprise plans only.
A Workflow comprises two fundamental components: Triggers and Actions. By tailoring these triggers and actions to your specific requirements, you can tailor a Workflow to suit your unique use case.
Triggers are events that dictate when actions should be executed. You can add multiple trigger conditions within each Workflow.
Note: In the case of multiple trigger conditions, all the conditions should be met in order to execute the actions.
Here is a list of supported triggers:
When an Incident is Triggered
When Incident is Acknowledged
When Incident is Reassigned
When the Incident is Resolved
When Incident Tags are updated
When Incident Priority is updated
When Incident Note is added
For each of the triggers, here are the available filters and their conditions:
Service - is/is-not/contains/does not contain
Alert Source - is/is-not/contains/does not contain
Tags - is/is-not
Priority - is/is-not
To emphasize once more, it's essential for all conditions to be satisfied for the actions to be executed.
Each Workflow includes a predefined sequence of actions that determine the progression of the Workflow. These actions may involve tasks such as attaching Runbook(s) or marking an incident as SLO-affecting.
Here is a list of the supported Squadcast actions:
Add Status Page Issue
Here is a list of the supported Slack actions:
Here is a list of the supported Jira actions:
Here is a list of the supported MS Teams actions:
Important: When selecting the "Mark Incident as SLO Affecting" action, please ensure that you choose an active SLO that is associated with the same service as your incident.
Note:
Each action will be executed serially, and all actions executed by a Workflow will be recorded in the Incident timeline.
A Workflow will continue to run irrespective of the success/failure of a specific action.
To effectively create and manage Workflows, the user assigned to the Team must possess the appropriate permissions corresponding to their User Role.
To create a new workflow using the web app,
Navigate to the Workflows page -> Create Workflow.
Enter the Title, optional Description, Workflow Owner, and Tags.
How to Pick an Owner?
A Workflow Owner is the designated contact for clarifications, adjustments, or removal of a Workflow. By default, the Team is assigned as the owner, but you can modify it using the drop-down menu. How to use Tags?
Choose tags to organize, classify, and add context to your Workflows. For instance, adding tags like Environment, Cluster/Team name, and Priority can help structure and add more context to your Workflows.
Next, select the Trigger and its filters:
You can select between the following triggers:
When incident is Triggered
When incident is Acknowledged
When incident is Reassigned
When incident is Resolved
When Incident Tags are updated
When Incident Priority is updated
When Incident Note is added
For each of the trigger events, here are the available filters and their conditions:
Service - is/is-not/contains/does not contain
Alert Source - is/is-not/contains/does not contain
Tags - is/is-not
Priority - is/is-not
You can add a group of Triggers which all must hold true to set off the actions. Additionally, you can add a collection of filters using OR/AND conditions to consolidate their effects.
Next, select the Actions you want the Workflow to execute. These actions will execute one after the other.
You can select between the following Squadcast actions:
Add Status Page Issue
Or, you can select between the following Slack actions:
Or, you can select between the following Jira actions:
Or, you can select between the following MS Teams actions:
Important: When selecting the "Mark Incident as SLO Affecting" action, please ensure that you choose an active SLO that is associated with the same service as your incident.
Note:
Each action will be executed serially, and all actions executed by workflows will be recorded in the Incident timeline.
The workflow will continue to run irrespective of the success/failure of a specific action.
5. Once all details have been added, click Done.
After creating the Workflow, you will be automatically directed to the details page of the newly created Workflow. Here, you can access more information and logs related to this Workflow.
Additionally, you have the option to edit, update, or delete the Workflow directly from this details page.
Note: Please note that you have access to the execution logs (audit logs) for the Workflow from the last 30 days.
To edit a workflow,
Navigate to the Workflows page -> Click on the Workflow you want to edit, and you'll be directed to its details page.
From the three-dot menu, select Edit. -> The Workflows form, containing all the entered details, will appear. Once you've made the necessary updates, click Close.
Note: The changes you make to the Workflow will be auto-saved.
To delete a workflow,
Navigate to the Workflows page -> Click on the Workflow you want to remove, and you'll be directed to its details page.
From the three-dot menu, select Delete -> A confirmation modal will appear, click on Delete again to confirm.
Alternatively, you have the option to delete the Workflow directly from the listing page.
Show the logs of the workflows that have been executed and all of their corresponding details.
Field | Description |
---|---|
Execution Date & Time | Displays the date and time when the workflow was executed. |
Log ID | Displays the log id of the executed workflow. |
Status | Displays where it was executed successfully or not. |
Incident | Displays the incident that triggered the workflow. |
Actions Executed | Displays the no. of actions executed under it. |
To view further details about the executed actions,
Within the Workflows details page, navigate to the Logs section.
On hover, click on View Log Detail -> Here you can find the list of actions executed as part of the Workflow along with their individual timestamp.
Have any questions? Ask the community.