List workflows

GET

workflows

curl --request GET \
  --url https://api.rootly.com/v1/workflows \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "<string>",
      "type": "workflows",
      "attributes": {
        "name": "<string>",
        "slug": "<string>",
        "description": "<string>",
        "command": "<string>",
        "command_feedback_enabled": true,
        "wait": "<string>",
        "repeat_every_duration": "<string>",
        "repeat_condition_duration_since_first_run": "<string>",
        "repeat_condition_number_of_repeats": 123,
        "continuously_repeat": true,
        "repeat_on": [
          "S"
        ],
        "enabled": true,
        "locked": true,
        "position": 123,
        "workflow_group_id": "<string>",
        "trigger_params": {
          "trigger_type": "incident",
          "triggers": [
            "<string>"
          ],
          "incident_visibilities": [
            true
          ],
          "incident_kinds": [
            "test"
          ],
          "incident_statuses": [
            "in_triage"
          ],
          "incident_inactivity_duration": "<any>",
          "incident_condition": "ALL",
          "incident_condition_visibility": "ANY",
          "incident_condition_kind": "IS",
          "incident_condition_status": "ANY",
          "incident_condition_sub_status": "ANY",
          "incident_condition_environment": "ANY",
          "incident_condition_severity": "ANY",
          "incident_condition_incident_type": "ANY",
          "incident_condition_incident_roles": "ANY",
          "incident_condition_service": "ANY",
          "incident_condition_functionality": "ANY",
          "incident_condition_group": "ANY",
          "incident_condition_cause": "ANY",
          "incident_post_mortem_condition_cause": "ANY",
          "incident_condition_summary": "<any>",
          "incident_condition_started_at": "<any>",
          "incident_condition_detected_at": "<any>",
          "incident_condition_acknowledged_at": "<any>",
          "incident_condition_mitigated_at": "<any>",
          "incident_condition_resolved_at": "<any>",
          "incident_conditional_inactivity": "<any>"
        },
        "environment_ids": [
          "<string>"
        ],
        "severity_ids": [
          "<string>"
        ],
        "incident_type_ids": [
          "<string>"
        ],
        "incident_role_ids": [
          "<string>"
        ],
        "service_ids": [
          "<string>"
        ],
        "functionality_ids": [
          "<string>"
        ],
        "group_ids": [
          "<string>"
        ],
        "cause_ids": [
          "<string>"
        ],
        "sub_status_ids": [
          "<string>"
        ],
        "created_at": "<string>",
        "updated_at": "<string>"
      }
    }
  ],
  "links": {
    "self": "<string>",
    "first": "<string>",
    "prev": "<string>",
    "next": "<string>",
    "last": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

include

enum<string>

comma separated if needed. eg: form_field_conditions,genius_tasks

Available options:

form_field_conditions,

genius_tasks,

genius_workflow_runs

sort

enum<string>

comma separated if needed. eg: created_at,updated_at

Available options:

created_at,

-created_at,

updated_at,

-updated_at,

position,

-position

page[number]

integer

page[size]

integer

filter[search]

string

filter[name]

string

filter[slug]

string

filter[created_at][gt]

string

filter[created_at][gte]

string

filter[created_at][lt]

string

filter[created_at][lte]

string

Response

200 - application/vnd.api+json

success

data

object[]

required

data.id

string

required

Unique ID of the workflow

data.type

enum<string>

required

Available options:

workflows

data.attributes

object

required

data.attributes.name

string

required

The title of the workflow

data.attributes.created_at

string

required

Date of creation

data.attributes.updated_at

string

required

Date of last update

data.attributes.slug

string

The slug of the workflow

data.attributes.description

string | null

The description of the workflow

data.attributes.command

string | null

Workflow command

data.attributes.command_feedback_enabled

boolean | null

This will notify you back when the workflow is starting

data.attributes.wait

string | null

Wait this duration before executing

data.attributes.repeat_every_duration

string | null

Repeat workflow every duration

data.attributes.repeat_condition_duration_since_first_run

string | null

The workflow will stop repeating if its runtime since it's first workflow run exceeds the duration set in this field

data.attributes.repeat_condition_number_of_repeats

integer

The workflow will stop repeating if the number of repeats exceeds the value set in this field

data.attributes.continuously_repeat

boolean

When continuously repeat is true, repeat workflows aren't automatically stopped when conditions aren't met. This setting won't override your conditions set by repeat_condition_duration_since_first_run and repeat_condition_number_of_repeats parameters.

data.attributes.repeat_on

enum<string>[] | null

Repeat on weekdays

Available options:

S,

M,

T,

W,

R,

F,

U

data.attributes.enabled

boolean

data.attributes.locked

boolean

Restricts workflow edits to admins when turned on. Only admins can set this field.

data.attributes.position

integer

The order which the workflow should run with other workflows.

data.attributes.workflow_group_id

string | null

The group this workflow belongs to.

data.attributes.trigger_params

object

data.attributes.trigger_params.trigger_type

enum<string>

required

Available options:

incident

data.attributes.trigger_params.triggers

string[]

Actions that trigger the workflow. One of custom_fields.<slug>.updated, incident_in_triage, incident_created, incident_started, incident_updated, title_updated, summary_updated, status_updated, severity_updated, environments_added, environments_removed, environments_updated, incident_types_added, incident_types_removed, incident_types_updated, services_added, services_removed, services_updated, visibility_updated, functionalities_added, functionalities_removed, functionalities_updated, teams_added, teams_removed, teams_updated, causes_added, causes_removed, causes_updated, timeline_updated, status_page_timeline_updated, role_assignments_updated, role_assignments_added, role_assignments_removed, slack_command, slack_channel_created, slack_channel_converted, microsoft_teams_channel_created, subscribers_updated, subscribers_added, subscribers_removed, user_joined_slack_channel, user_left_slack_channel

data.attributes.trigger_params.incident_visibilities

boolean[]

data.attributes.trigger_params.incident_kinds

enum<string>[]

Available options:

test,

test_sub,

example,

example_sub,

normal,

normal_sub,

backfilled,

scheduled

data.attributes.trigger_params.incident_statuses

enum<string>[]

Available options:

in_triage,

started,

detected,

acknowledged,

mitigated,

resolved,

closed,

cancelled,

scheduled,

in_progress,

completed

data.attributes.trigger_params.incident_inactivity_duration

data.attributes.trigger_params.incident_condition

enum<string>

default:ALL

Available options:

ALL,

ANY,

NONE

data.attributes.trigger_params.incident_condition_visibility

enum<string>

default:ANY

Available options:

IS,

ANY,

CONTAINS,

CONTAINS_ALL,

CONTAINS_NONE,

NONE,

SET,

UNSET

data.attributes.trigger_params.incident_condition_kind

enum<string>

default:IS

Available options:

IS,

ANY,

CONTAINS,

CONTAINS_ALL,

CONTAINS_NONE,

NONE,

SET,

UNSET

data.attributes.trigger_params.incident_condition_status

enum<string>

default:ANY

Available options:

IS,

ANY,

CONTAINS,

CONTAINS_ALL,

CONTAINS_NONE,

NONE,

SET,

UNSET

data.attributes.trigger_params.incident_condition_sub_status

enum<string>

default:ANY

Available options:

IS,

ANY,

CONTAINS,

CONTAINS_ALL,

CONTAINS_NONE,

NONE,

SET,

UNSET

data.attributes.trigger_params.incident_condition_environment

enum<string>

default:ANY

Available options:

IS,

ANY,

CONTAINS,

CONTAINS_ALL,

CONTAINS_NONE,

NONE,

SET,

UNSET

data.attributes.trigger_params.incident_condition_severity

enum<string>

default:ANY

Available options:

IS,

ANY,

CONTAINS,

CONTAINS_ALL,

CONTAINS_NONE,

NONE,

SET,

UNSET

data.attributes.trigger_params.incident_condition_incident_type

enum<string>

default:ANY

Available options:

IS,

ANY,

CONTAINS,

CONTAINS_ALL,

CONTAINS_NONE,

NONE,

SET,

UNSET

data.attributes.trigger_params.incident_condition_incident_roles

enum<string>

default:ANY

Available options:

IS,

ANY,

CONTAINS,

CONTAINS_ALL,

CONTAINS_NONE,

NONE,

SET,

UNSET

data.attributes.trigger_params.incident_condition_service

enum<string>

default:ANY

Available options:

IS,

ANY,

CONTAINS,

CONTAINS_ALL,

CONTAINS_NONE,

NONE,

SET,

UNSET

data.attributes.trigger_params.incident_condition_functionality

enum<string>

default:ANY

Available options:

IS,

ANY,

CONTAINS,

CONTAINS_ALL,

CONTAINS_NONE,

NONE,

SET,

UNSET

data.attributes.trigger_params.incident_condition_group

enum<string>

default:ANY

Available options:

IS,

ANY,

CONTAINS,

CONTAINS_ALL,

CONTAINS_NONE,

NONE,

SET,

UNSET

data.attributes.trigger_params.incident_condition_cause

enum<string>

default:ANY

Available options:

IS,

ANY,

CONTAINS,

CONTAINS_ALL,

CONTAINS_NONE,

NONE,

SET,

UNSET

data.attributes.trigger_params.incident_post_mortem_condition_cause

enum<string>

default:ANY

[DEPRECATED] Use incident_condition_cause instead

Available options:

IS,

ANY,

CONTAINS,

CONTAINS_ALL,

CONTAINS_NONE,

NONE,

SET,

UNSET

data.attributes.trigger_params.incident_condition_summary

data.attributes.trigger_params.incident_condition_started_at

data.attributes.trigger_params.incident_condition_detected_at

data.attributes.trigger_params.incident_condition_acknowledged_at

data.attributes.trigger_params.incident_condition_mitigated_at

data.attributes.trigger_params.incident_condition_resolved_at

data.attributes.trigger_params.incident_conditional_inactivity

data.attributes.environment_ids

string[]

data.attributes.severity_ids

string[]

data.attributes.incident_type_ids

string[]

data.attributes.incident_role_ids

string[]

data.attributes.service_ids

string[]

data.attributes.functionality_ids

string[]

data.attributes.group_ids

string[]

data.attributes.cause_ids

string[]

data.attributes.sub_status_ids

string[]

links

object

required

Was this page helpful?

Creates a workflowCreates a new workflow from provided data

curl --request GET \
  --url https://api.rootly.com/v1/workflows \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "<string>",
      "type": "workflows",
      "attributes": {
        "name": "<string>",
        "slug": "<string>",
        "description": "<string>",
        "command": "<string>",
        "command_feedback_enabled": true,
        "wait": "<string>",
        "repeat_every_duration": "<string>",
        "repeat_condition_duration_since_first_run": "<string>",
        "repeat_condition_number_of_repeats": 123,
        "continuously_repeat": true,
        "repeat_on": [
          "S"
        ],
        "enabled": true,
        "locked": true,
        "position": 123,
        "workflow_group_id": "<string>",
        "trigger_params": {
          "trigger_type": "incident",
          "triggers": [
            "<string>"
          ],
          "incident_visibilities": [
            true
          ],
          "incident_kinds": [
            "test"
          ],
          "incident_statuses": [
            "in_triage"
          ],
          "incident_inactivity_duration": "<any>",
          "incident_condition": "ALL",
          "incident_condition_visibility": "ANY",
          "incident_condition_kind": "IS",
          "incident_condition_status": "ANY",
          "incident_condition_sub_status": "ANY",
          "incident_condition_environment": "ANY",
          "incident_condition_severity": "ANY",
          "incident_condition_incident_type": "ANY",
          "incident_condition_incident_roles": "ANY",
          "incident_condition_service": "ANY",
          "incident_condition_functionality": "ANY",
          "incident_condition_group": "ANY",
          "incident_condition_cause": "ANY",
          "incident_post_mortem_condition_cause": "ANY",
          "incident_condition_summary": "<any>",
          "incident_condition_started_at": "<any>",
          "incident_condition_detected_at": "<any>",
          "incident_condition_acknowledged_at": "<any>",
          "incident_condition_mitigated_at": "<any>",
          "incident_condition_resolved_at": "<any>",
          "incident_conditional_inactivity": "<any>"
        },
        "environment_ids": [
          "<string>"
        ],
        "severity_ids": [
          "<string>"
        ],
        "incident_type_ids": [
          "<string>"
        ],
        "incident_role_ids": [
          "<string>"
        ],
        "service_ids": [
          "<string>"
        ],
        "functionality_ids": [
          "<string>"
        ],
        "group_ids": [
          "<string>"
        ],
        "cause_ids": [
          "<string>"
        ],
        "sub_status_ids": [
          "<string>"
        ],
        "created_at": "<string>",
        "updated_at": "<string>"
      }
    }
  ],
  "links": {
    "self": "<string>",
    "first": "<string>",
    "prev": "<string>",
    "next": "<string>",
    "last": "<string>"
  }
}

Overview

AlertEvents

AlertGroups

AlertRoutingRules

AlertUrgencies

AlertSources

Alerts

Audits

Authorizations

CatalogEntities

CatalogEntityProperties

CatalogFields

Catalogs

Causes

[DEPRECATED] CustomFieldOptions

[DEPRECATED] CustomFields

CustomForms

DashboardPanels

Dashboards

Environments

EscalationPolicies

EscalationLevelsPolicies

EscalationLevelsPath

EscalationLevels

EscalationPaths

FormFieldOptions

FormFieldPlacementConditions

FormFieldPlacements

FormFieldPositions

FormFields

FormSetConditions

FormSets

Functionalities

WorkflowTasks

[DEPRECATED] WorkflowCustomFieldSelections

WorkflowFormFieldConditions

WorkflowGroups

WorkflowRuns

Workflows

Heartbeats

IncidentActionItems

[DEPRECATED] IncidentCustomFieldSelections

IncidentEventFunctionalities

IncidentEventServices

IncidentEvents

IncidentFeedbacks

IncidentFormFieldSelections

IncidentPermissionSetBooleans

IncidentPermissionSetResources

IncidentPermissionSets

IncidentRetrospectives

IncidentRetrospectiveSteps

IncidentRoleTasks

IncidentRoles

IncidentStatusPageEvents

IncidentSubStatuses

IncidentTypes

Incidents

IpRanges

LiveCallRouters

OnCallRoles

OnCallShadows

OverrideShifts

PlaybookTasks

Playbooks

RetrospectiveTemplates

Pulses

RetrospectiveConfigurations

RetrospectiveProcessGroupSteps

RetrospectiveProcessGroups

RetrospectiveProcesses

RetrospectiveSteps

Roles

ScheduleRotationActiveDays

ScheduleRotationUsers

ScheduleRotations

Schedules

Shifts

Secrets

Services