Skip to main content

​
Overview

The get_incident_workflow tool retrieves detailed information about a specific incident workflow, including its configuration, steps, and team associations.
This is a read-only tool that does not modify any data in your PagerDuty account.

​
Parameters

​
workflow_id
string
required
The unique identifier of the incident workflow to retrieve.Example: "PZYX123"

​
Response

Returns a detailed incident workflow object.
​
id
string
The unique identifier of the incident workflow
​
type
string
Always returns "incident_workflow"
​
name
string
A descriptive name for the incident workflow
​
description
string
A description of what the incident workflow does
​
is_enabled
boolean
Indicates whether the incident workflow is currently enabled. Disabled workflows will not execute.
​
team
object
Team reference. If specified, workflow edit permissions are scoped to members of this team.
​
steps
array
The ordered list of steps that execute sequentially as part of the workflow.
​
summary
string
A short-form, server-generated description
​
self
string
The API URL at which this workflow is accessible
​
html_url
string
The URL at which this workflow is accessible in the PagerDuty web UI
​
created_at
datetime
The timestamp this incident workflow was created

​
Example Usage

"Show me the details of workflow PZYX123"

​
Use Cases

  • Review workflow configuration - Examine the complete setup of a workflow
  • Understand workflow steps - See what actions will be performed when the workflow executes
  • Verify team permissions - Check which team can edit this workflow
  • Audit automation - Review the specific actions and inputs configured
  • Debug workflows - Troubleshoot workflow behavior by examining configuration

​
Response Example

{
  "id": "PZYX123",
  "type": "incident_workflow",
  "name": "Major Incident Response",
  "description": "Automated workflow for major incident escalation",
  "is_enabled": true,
  "team": {
    "id": "PTEAM1",
    "type": "team_reference",
    "summary": "Platform Team"
  },
  "steps": [
    {
      "id": "STEP1",
      "type": "step",
      "name": "Notify stakeholders",
      "action_configuration": {
        "action_id": "send_notification"
      }
    }
  ],
  "created_at": "2024-01-15T10:30:00Z"
}

Build docs developers (and LLMs) love

Get started for freeTalk to us