LogoLogo
Login to CortexBook a DemoCortex Academycortex.io
  • Cortex Docs
  • Cortex Quick Start
  • Ingesting data into Cortex
    • Managing Entities
      • Adding entities
        • Add services
        • Add domains
        • Add teams
        • Add custom entity types
        • Defining dependencies
      • Entity details page
      • Defining ownership
      • Defining relationship types
      • Grouping entities
      • Adding external documentation
      • Adding Deploy data
      • Adding custom data
      • Viewing discovered entities
      • Archiving entities
      • Relationship graph
      • Using On-call Assistant for incidents
      • Managing Terraform infra in Cortex
    • Managing Catalogs
    • Integrations
      • Internally hosted integrations
      • ArgoCD
      • AWS
      • Azure DevOps
      • Azure Resources
      • BambooHR
      • Bitbucket
      • BugSnag
      • Buildkite
      • Checkmarx
      • CircleCI
      • ClickUp
      • Codecov
      • Coralogix
      • Custom webhook integrations
      • Datadog
      • Dynatrace
      • Entra ID (Azure AD)
      • FireHydrant
      • GitHub
      • GitLab
      • Google
      • Grafana
      • incident.io
      • Instana
      • Jenkins
      • Jira
      • Kubernetes
      • LaunchDarkly
      • Lightstep
      • Mend
      • Microsoft Teams
      • New Relic
      • Okta
      • Opsgenie
      • PagerDuty
      • Prometheus
      • Rollbar
      • Rootly
      • Sentry
      • ServiceNow
      • Slack
      • Snyk
      • SonarQube
      • Splunk Observability Cloud (SignalFx)
      • Splunk On-Call (VictorOps)
      • Sumo Logic
      • Veracode
      • Wiz
      • Workday
      • xMatters
  • Scorecards
    • Initiatives and Action items
      • Creating issues based on Initiatives
    • Scorecard rule exemptions
    • Scorecard rule filters
    • Scorecard examples
    • Scorecards as code
  • Reports
    • Executive report
    • All Scorecards report
    • Bird's eye report
    • Progress report
    • Report card
  • Eng Intelligence
    • Custom Metrics
    • Jira Metrics
    • Metrics Explorer (Beta)
  • Cortex Query Language (CQL)
    • Using CQL reports
    • Using JQ in Cortex
  • Workflows
    • Creating a Workflow
      • Workflows as code
    • Blocks
    • Running a Workflow
    • Registering a Scaffolder template
      • Scaffolder advanced usage
    • Using a Workflow to sync in ArgoCD
    • Kicking off a Jenkins pipeline in a Workflow
    • Calling internal service endpoints in a Workflow
  • Plugins
    • Creating a plugin
      • Creating a plugin proxy
    • Migrating Backstage plugins to Cortex
  • Engineering homepage
  • Workspace Settings
    • Using GitOps for Cortex
      • GitOps logs
    • Managing users
      • Roles and permissions
        • Custom roles
        • Team ownership entity editing
      • Configuring SSO
        • Microsoft Entra ID
        • Google
        • Other OIDC providers
        • Okta
          • Okta SCIM
      • Configuring identity mappings
      • Onboarding management
    • API keys, secrets, and tokens
      • Secrets
      • Personal tokens
    • Audit logs
    • Entity settings
      • Data verification
      • Auto archiving entities
    • IP allowlist
    • Notifications
      • Notification logs
    • Customizing your workspace
    • Using search in Cortex
  • Cortex API
    • REST API operations
      • API Keys
      • Audit Logs
      • Catalog Entities
      • Custom Data
        • Custom Data (Advanced)
      • Custom Events
      • Custom Metrics
      • Dependencies
      • Deploys
      • Discovery Audit
      • Docs
      • Eng Intel: User Labels
      • Entity Relationship Types (Beta)
      • Entity Relationships (Beta)
      • Entity Types
      • GitOps Logs
      • Groups
      • Initiatives
      • Integrations APIs
        • Azure Active Directory (Entra ID) API
        • Azure Resources API
        • AWS API
        • Azure DevOps API
        • CircleCI API
        • Coralogix API
        • Datadog API
        • GitHub API
        • GitLab API
        • incident.io API
        • LaunchDarkly API
        • New Relic API
        • PagerDuty API
        • Prometheus API
        • SonarQube API
      • IP Allowlist
      • Notification Logs
      • On call
      • Packages
      • Plugins
      • Queries
      • SCIM
      • Scorecards
      • Secrets
      • Team Hierarchies
      • Teams
      • Workflows
Powered by GitBook
On this page
  • Overview
  • Methods for managing Workflows
  • Creating and running Workflows
  • Workflow RBAC
  • Viewing Workflows
  • View Workflow runs
  • View Scaffolder templates
  • Workflow use cases

Was this helpful?

Export as PDF

Workflows

Last updated 14 hours ago

Was this helpful?

Overview

The Workflows tool in Cortex allows you to automate running sequential actions and development workflows based on contextual data that exist inside your workspace. This tool supports both simple Workflows, like granting permissions to a database, and sophisticated ones, like creating a Jira ticket for an incident detected in Cortex.

Looking for a quick introduction to Workflows? Check out the , available to all Cortex customers and POVs.

Methods for managing Workflows

You can manage Workflows in the or via . You can also use to create, read, update, and delete Workflows.

Creating and running Workflows

Learn more in the following pages:

    • Learn about managing Workflows via GitOps in .

Workflow RBAC

It is possible to configure specific users, teams, or roles who are allowed to run a Workflow, or you can require the user to be an Owner or Editor of an entity in order to run the Workflow. This is described in more detail on .

It is also possible to add a "Manual approval" block to your Workflow, requiring approval from specific team members. Read more about configuring this under .

Viewing Workflows

At the top of the page, quickly see any Workflows that are pending your approval and a list of recently run Workflows.

In the Workflows tab, view all existing Workflows, including each Workflow's name and description.

  • You can click the pin icon to pin any frequently-used Workflows to the top.

View Workflow runs

In the Runs tab on the Workflows page, view historic runs for each Workflow.

  • To view previous Workflow runs, you must have the View Workflow runs permission.

View Scaffolder templates

  • Click the rocketship icon to create a Workflow that contains a Scaffolder step with that template:

Workflow use cases

See example Workflows in the following pages:

To see your , click Workflows in the lefthand navigation menu. To view existing Workflows, you must have the View Workflows permission.

From this page, you can edit, duplicate, run, delete, share, or create a Workflow. Click Run to run the Workflow. Click the 3 dots icon to view options to edit, duplicate, share, or delete the Workflow.

If a Workflow is in draft mode, you'll also see a Draft icon next to its name.

Read more in .

In the Scaffolders tab on the Workflows page, view, edit, or delete your organization's registered .

Workflows
Running a Workflow
Scaffolder templates
Using a Workflow to sync in ArgoCD
Kicking off a Jenkins pipeline in a Workflow
Calling internal service endpoints in a Workflow
Cortex Academy "Intro to Workflows" course
Cortex UI
GitOps
the API
Creating a Workflow
Workflows as code
Running a Workflow
Creating a Workflow
Add blocks to your Workflow