Links

Workflows

Configure a predefined set of actions to automate responses to incidents.
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.
Image. Workflow
Note: This feature will be available in the Premium and Enterprise plans only.

Workflow Components

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

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

Trigger Properties/Filters

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.

Actions

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:
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.

Prerequisite

  • To effectively create and manage Workflows, the user assigned to the Team must possess the appropriate permissions corresponding to their User Role.

Add Workflows

To create a new workflow using the web app,
  1. 1.
    Navigate to the Workflows page -> Create Workflow.
  2. 2.
    Enter the Title, optional Description, Workflow Owner, and Tags.
Image. Create Workflow
Image. Add Details on Title, Description, 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.
  1. 3.
    Next, select the Trigger and its filters:
    1. 1.
      You can select between the following triggers:
      1. 1.
        When incident is Triggered
      2. 2.
        When incident is Acknowledged
      3. 3.
        When incident is Reassigned
      4. 4.
        When incident is Resolved
    2. 2.
      For each of the trigger events, here are the available filters and their conditions:
      1. 1.
        Service - is/is-not/contains/does not contain
      2. 2.
        Alert Source - is/is-not/contains/does not contain
      3. 3.
        Tags - is/is-not
      4. 4.
        Priority - is/is-not
    You can add a group of Triggers which all must hold true to set off the actions.
Image. Define Tigger and its Filters
  1. 4.
    Next, select the Actions you want the Workflow to execute. These actions will execute one after the other.
    1. 1.
      You can select between the following Squadcast actions:
    2. 3.
      Or, you can select between the following Jira actions:
    3. 4.
      Or, you can select between the following MS Teams actions:
Image. Define Actions
Image. Add Details for Sequence of 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.
Image. Workflow Details Page
Note: Please note that you have access to the execution logs (audit logs) for the Workflow from the last 30 days.

Edit Workflows

To edit a workflow,
  1. 1.
    Navigate to the Workflows page -> Click on the Workflow you want to edit, and you'll be directed to its details page.
  2. 2.
    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.
Image. Select Workflow
Image. Edit Workflow
Image. Update Workflow Details
Note: The changes you make to the Workflow will be auto-saved.

Delete Workflows

To delete a workflow,
  1. 1.
    Navigate to the Workflows page -> Click on the Workflow you want to remove, and you'll be directed to its details page.
  2. 2.
    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.
Image. Select Workflow
Image. Delete Workflow
Image. Confirm Deletion

Logs

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,
  1. 1.
    Within the Workflows details page, navigate to the Logs section.
  2. 2.
    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.
Image. View Logs
Image. View Log Details
Have any questions? Ask the community.