incident.io

https://docs.incident.io/api-reference
Admin
incident.io is an incident management platform that helps teams manage alerts, incidents, and...
Tokens:751,225
Snippets:5,528
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Maintenance Window Notify Start Minutes Example

Source: https://docs.incident.io/api-reference/maintenancewindows-v1/update

Example of minutes before the start to send a notification.

```integer
15
```

--------------------------------

### Rotation Users Example

Source: https://docs.incident.io/api-reference/schedules-v2/list

Example of the users array configuration.

```yaml
- email: lisa@incident.io
  id: 01FCNDV6P870EA6S7TK1DSYDG0
  name: Lisa Karlin Curtis
  role: owner
  slack_user_id: U02AYNF2XJM
```

--------------------------------

### Rotation Handovers Example

Source: https://docs.incident.io/api-reference/schedules-v2/list

Example of the handovers array configuration.

```yaml
- interval: 1
  interval_type: hourly
```

--------------------------------

### List Workflows V2 Response

Source: https://docs.incident.io/api-reference/workflows-v2/list

Example JSON response for the GET /v2/workflows endpoint.

```json
{
  "workflows": [
    {
      "condition_groups": [
        {
          "conditions": [
            {
              "operation": {
                "label": "Lawrence Jones",
                "value": "01FCQSP07Z74QMMYPDDGQB9FTG"
              },
              "param_bindings": [
                {
                  "array_value": [
                    {
                      "label": "Lawrence Jones",
                      "literal": "SEV123",
                      "reference": "incident.severity"
                    }
                  ],
                  "value": {
                    "label": "Lawrence Jones",
                    "literal": "SEV123"
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}
```

--------------------------------

### Notify Minutes Before Examples

Source: https://docs.incident.io/api-reference/maintenancewindows-v1/create

Examples for notification timing settings.

```yaml
5
```

```yaml
15
```

--------------------------------

### Workflow Steps Configuration Example

Source: https://docs.incident.io/api-reference/workflows-v2/show

Example structure for defining steps within a workflow, including parameter bindings.

```yaml
- for_each: abc123
  id: abc123
  label: PagerDuty Escalate
  name: pagerduty.escalate
  param_bindings:
    - array_value:
        - label: Lawrence Jones
          literal: SEV123
          reference: incident.severity
      value:
        label: Lawrence Jones
        literal: SEV123
        reference: incident.severity
```

--------------------------------

### ScheduleRotationHandoverV2 Object Example

Source: https://docs.incident.io/api-reference/schedules-v2/update

Example of a handover configuration object.

```yaml
interval: 1
interval_type: hourly
```

--------------------------------

### Rotation Layers Example

Source: https://docs.incident.io/api-reference/schedules-v2/list

Example of the layers array configuration.

```yaml
- id: 01G0J1EXE7AXZ2C93K61WBPYEH
  name: Layer 1
```

--------------------------------

### WorkflowDelayV2 Example

Source: https://docs.incident.io/api-reference/workflows-v2/update

An example of the WorkflowDelayV2 configuration, specifying delay duration and condition re-checking behavior.

```yaml
conditions_apply_over_delay: false
        for_seconds: 60
```

--------------------------------

### EngineParamBindingPayloadV2 Example

Source: https://docs.incident.io/api-reference/workflows-v2/update

Example structure for binding parameters within the workflow engine.

```yaml
array_value:
          - literal: SEV123
            reference: incident.severity
        value:
          literal: SEV123
          reference: incident.severity
```

--------------------------------

### Workflow folder example

Source: https://docs.incident.io/api-reference/workflows-v2/update

Example of the string field used to specify the folder where the workflow is displayed.

```yaml
folder:
  description: Folder to display the workflow in
  example: My folder 01
  type: string
```

--------------------------------

### ExpressionBranchPayloadV2 Schema Example

Source: https://docs.incident.io/api-reference/workflows-v2/create

Example structure for ExpressionBranchPayloadV2, illustrating condition groups and result bindings.

```yaml
example:
  condition_groups:
    - conditions:
        - operation: one_of
          param_bindings:
            - array_value:
                - literal: SEV123
                  reference: incident.severity
              value:
                literal: SEV123
                reference: incident.severity
          subject: incident.severity
  result:
    array_value:
      - literal: SEV123
        reference: incident.severity
    value:
      literal: SEV123
      reference: incident.severity
```

--------------------------------

### ExpressionV2 Example

Source: https://docs.incident.io/api-reference/workflows-v2/update

Example of a complex expression including branches and operations.

```yaml
else_branch:
          result:
            array_value:
              - label: Lawrence Jones
                literal: SEV123
                reference: incident.severity
            value:
              label: Lawrence Jones
              literal: SEV123
              reference: incident.severity
        label: Team Slack channel
        operations:
          - branches:
              branches:
                - condition_groups:
                    - conditions:
                        - operation:
                            label: Lawrence Jones
                            value: 01FCQSP07Z74QMMYPDDGQB9FTG
                          param_bindings:
                            - array_value:
                                - label: Lawrence Jones
                                  literal: SEV123
                                  reference: incident.severity
                              value:
                                label: Lawrence Jones
                                literal: SEV123
                                reference: incident.severity
                          subject:
```

--------------------------------

### EngineParamBindingV2 Schema Example

Source: https://docs.incident.io/api-reference/workflows-v2/show

Example structure for binding parameters within the workflow engine.

```yaml
example:
        array_value:
          - label: Lawrence Jones
            literal: SEV123
            reference: incident.severity
        value:
          label: Lawrence Jones
          literal: SEV123
          reference: incident.severity
```

--------------------------------

### OpenAPI Expression Operation Example

Source: https://docs.incident.io/api-reference/workflows-v2/update

Example of an operation configuration including navigation and parsing logic.

```yaml
- conditions:
                - operation: one_of
                  param_bindings:
                    - array_value:
                        - literal: SEV123
                          reference: incident.severity
                      value:
                        literal: SEV123
                        reference: incident.severity
                  subject: incident.severity
        navigate:
          reference: catalog_attribute["01FCNDV6P870EA6S7TK1DSYD5H"]
        operation_type: navigate
        parse:
          returns:
            array: true
            type: IncidentStatus
          source: metadata.annotations["github.com/repo"]
```

--------------------------------

### OpenAPI ExpressionBranchV2 Schema Example

Source: https://docs.incident.io/api-reference/workflows-v2/update

Example structure for ExpressionBranchV2, defining condition groups and return metadata.

```yaml
- condition_groups:
              - conditions:
                  - operation:
                      label: Lawrence Jones
                      value: 01FCQSP07Z74QMMYPDDGQB9FTG
                    param_bindings:
                      - array_value:
                          - label: Lawrence Jones
                            literal: SEV123
                            reference: incident.severity
                        value:
                          label: Lawrence Jones
                          literal: SEV123
                          reference: incident.severity
                    subject:
                      label: Incident Severity
                      reference: incident.severity
            result:
              array_value:
                - label: Lawrence Jones
                  literal: SEV123
                  reference: incident.severity
              value:
                label: Lawrence Jones
                literal: SEV123
                reference: incident.severity
        returns:
          array: true
          type: IncidentStatus
```

--------------------------------

### Workflow Annotations Example

Source: https://docs.incident.io/api-reference/workflows-v2/update

Example of the annotations object used to track metadata for a resource.

```yaml
incident.io/terraform/version: 3.0.0
```

--------------------------------

### WorkflowsListWorkflowsResultV2 Example

Source: https://docs.incident.io/api-reference/workflows-v2/list

An example of the WorkflowsListWorkflowsResultV2 object structure, detailing workflow conditions, delay settings, and expression operations.

```yaml
WorkflowsListWorkflowsResultV2:
  example:
    workflows:
      - condition_groups:
          - conditions:
              - operation:
                  label: Lawrence Jones
                  value: 01FCQSP07Z74QMMYPDDGQB9FTG
                param_bindings:
                  - array_value:
                      - label: Lawrence Jones
                        literal: SEV123
                        reference: incident.severity
                    value:
                      label: Lawrence Jones
                      literal: SEV123
                      reference: incident.severity
                subject:
                  label: Incident Severity
                  reference: incident.severity
        continue_on_step_error: true
        delay:
          conditions_apply_over_delay: false
          for_seconds: 60
        expressions:
          - else_branch:
              result:
                array_value:
                  - label: Lawrence Jones
                    literal: SEV123
                    reference: incident.severity
                value:
                  label: Lawrence Jones
                  literal: SEV123
                  reference: incident.severity
            label: Team Slack channel
            operations:
              - branches:
                  branches:
                    - condition_groups:
                        - conditions:
                            - operation:
                                label: Lawrence Jones
                                value: 01FCQSP07Z74QMMYPDDGQB9FTG
                              param_bindings:
                                - array_value:
                                    - label: Lawrence Jones
                                      literal: SEV123
                                      reference: incident.severity
                                  value:
                                    label: Lawrence Jones
                                    literal: SEV123
                                    reference: incident.severity
                              subject:
                                label: Incident Severity
                                reference: incident.severity
                      result:
                        array_value:
                          - label: Lawrence Jones
                            literal: SEV123
                            reference: incident.severity
                        value:
                          label: Lawrence Jones
                          literal: SEV123
                          reference: incident.severity
                  returns:
                    array: true
                    type: IncidentStatus
                cast:
                  returns:
                    array: true
                    type: IncidentStatus
                concatenate:
                  reference: '1235'
                  reference_label: Teams
                filter:
                  condition_groups:
                    - conditions:
                        - operation:
                            label: Lawrence Jones
                            value: 01FCQSP07Z74QMMYPDDGQB9FTG
                          param_bindings:
                            - array_value:
                                - label: Lawrence Jones
                                  literal: SEV123
                                  reference: incident.severity
                              value:
                                label: Lawrence Jones
                                literal: SEV123
                                reference: incident.severity
                          subject:
                            label: Incident Severity
                            reference: incident.severity
                navigate:
                  reference: '1235'
                  reference_label: Teams
                operation_type: navigate
                parse:
                  returns:
                    array: true
                    type: IncidentStatus
                  source: metadata.annotations["github.com/repo"]
                returns:
                  array: true
                  type: IncidentStatus
            reference: abc123
            returns:
              array: true
              type: IncidentStatus
            root_reference: incident.status
        folder: My folder 01
        id: 01FCNDV6P870EA6S7TK1DSYDG0
        include_private_escalations: true
        include_private_incidents: true
```

--------------------------------

### WorkflowsShowWorkflowResultV2 Schema Example

Source: https://docs.incident.io/api-reference/workflows-v2/show

Example structure for the WorkflowsShowWorkflowResultV2 schema, detailing management metadata and workflow configuration.

```yaml
components:
  schemas:
    WorkflowsShowWorkflowResultV2:
      example:
        management_meta:
          annotations:
            incident.io/terraform/version: 3.0.0
          managed_by: dashboard
          source_url: https://github.com/my-company/infrastructure
        workflow:
          condition_groups:
            - conditions:
                - operation:
                    label: Lawrence Jones
                    value: 01FCQSP07Z74QMMYPDDGQB9FTG
                  param_bindings:
                    - array_value:
                        - label: Lawrence Jones
                          literal: SEV123
                          reference: incident.severity
                      value:
                        label: Lawrence Jones
                        literal: SEV123
                        reference: incident.severity
                  subject:
                    label: Incident Severity
                    reference: incident.severity
          continue_on_step_error: true
          delay:
            conditions_apply_over_delay: false
            for_seconds: 60
          expressions:
            - else_branch:
                result:
                  array_value:
                    - label: Lawrence Jones
                      literal: SEV123
                      reference: incident.severity
                  value:
                    label: Lawrence Jones
                    literal: SEV123
                    reference: incident.severity
              label: Team Slack channel
              operations:
                - branches:
                    branches:
                      - condition_groups:
                          - conditions:
                              - operation:
                                  label: Lawrence Jones
                                  value: 01FCQSP07Z74QMMYPDDGQB9FTG
                                param_bindings:
                                  - array_value:
                                      - label: Lawrence Jones
                                        literal: SEV123
                                        reference: incident.severity
                                    value:
                                      label: Lawrence Jones
                                      literal: SEV123
                                      reference: incident.severity
                                subject:
                                  label: Incident Severity
                                  reference: incident.severity
                        result:
                          array_value:
                            - label: Lawrence Jones
                              literal: SEV123
                              reference: incident.severity
                          value:
                            label: Lawrence Jones
                            literal: SEV123
                            reference: incident.severity
                    returns:
                      array: true
                      type: IncidentStatus
                  cast:
                    returns:
                      array: true
                      type: IncidentStatus
```

--------------------------------

### OpenAPI WorkflowFormFieldV2 Example

Source: https://docs.incident.io/api-reference/workflows-v2/show

Example structure for a workflow form field definition.

```yaml
example:
  array: true
  description: The customer affected by this incident
  id: 01FCNDV6P870EA6S7TK1DSYDG0
  key: affected_customer
  required: true
  title: Affected customer
  type: User
```

--------------------------------

### Workflow form_fields example

Source: https://docs.incident.io/api-reference/workflows-v2/update

Example configuration for user-defined form fields available in manual workflow triggers.

```yaml
form_fields:
  description: >-
    User-configured form fields available in the workflow scope (manual
    triggers only)
  example:
    - array: true
      description: The customer affected by this incident
      id: 01FCNDV6P870EA6S7TK1DSYDG0
      key: affected_customer
      required: true
      title: Affected customer
      type: User
```

--------------------------------

### Workflow Operations Schema Example

Source: https://docs.incident.io/api-reference/workflows-v2/create

A comprehensive example of the operations property, demonstrating branching, filtering, and navigation logic.

```yaml
branches:
  branches:
    - condition_groups:
        - conditions:
            - operation:
                label: Lawrence Jones
                value: 01FCQSP07Z74QMMYPDDGQB9FTG
              param_bindings:
                - array_value:
                    - label: Lawrence Jones
                      literal: SEV123
                      reference: incident.severity
                  value:
                    label: Lawrence Jones
                    literal: SEV123
                    reference: incident.severity
              subject:
                label: Incident Severity
                reference: incident.severity
      result:
        array_value:
          - label: Lawrence Jones
            literal: SEV123
            reference: incident.severity
        value:
          label: Lawrence Jones
          literal: SEV123
          reference: incident.severity
returns:
  array: true
  type: IncidentStatus
cast:
  returns:
    array: true
    type: IncidentStatus
concatenate:
  reference: '1235'
  reference_label: Teams
filter:
  condition_groups:
    - conditions:
        - operation:
            label: Lawrence Jones
            value: 01FCQSP07Z74QMMYPDDGQB9FTG
          param_bindings:
            - array_value:
                - label: Lawrence Jones
                  literal: SEV123
                  reference: incident.severity
              value:
                label: Lawrence Jones
                literal: SEV123
                reference: incident.severity
          subject:
            label: Incident Severity
            reference: incident.severity
navigate:
  reference: '1235'
  reference_label: Teams
operation_type: navigate
parse:
  returns:
    array: true
    type: IncidentStatus
```

--------------------------------

### WorkflowsUpdateWorkflowPayloadV2 Schema Example

Source: https://docs.incident.io/api-reference/workflows-v2/update

Example payload for updating a workflow, demonstrating condition groups, delay settings, and expression operations.

```yaml
    WorkflowsUpdateWorkflowPayloadV2:
      example:
        annotations:
          incident.io/terraform/version: 3.0.0
        condition_groups:
          - conditions:
              - operation: one_of
                param_bindings:
                  - array_value:
                      - literal: SEV123
                        reference: incident.severity
                    value:
                      literal: SEV123
                      reference: incident.severity
                subject: incident.severity
        continue_on_step_error: true
        delay:
          conditions_apply_over_delay: false
          for_seconds: 60
        expressions:
          - else_branch:
              result:
                array_value:
                  - literal: SEV123
                    reference: incident.severity
                value:
                  literal: SEV123
                  reference: incident.severity
            label: Team Slack channel
            operations:
              - branches:
                  branches:
                    - condition_groups:
                        - conditions:
                            - operation: one_of
                              param_bindings:
                                - array_value:
                                    - literal: SEV123
                                      reference: incident.severity
                                  value:
                                    literal: SEV123
                                    reference: incident.severity
                              subject: incident.severity
                      result:
                        array_value:
                          - literal: SEV123
                            reference: incident.severity
                        value:
                          literal: SEV123
                          reference: incident.severity
                  returns:
                    array: true
                    type: IncidentStatus
                cast:
                  returns:
                    array: true
                    type: IncidentStatus
                concatenate:
                  reference: catalog_attribute["01FCNDV6P870EA6S7TK1DSYD5H"]
                filter:
                  condition_groups:
                    - conditions:
                        - operation: one_of
                          param_bindings:
                            - array_value:
                                - literal: SEV123
                                  reference: incident.severity
                              value:
                                literal: SEV123
                                reference: incident.severity
                          subject: incident.severity
                navigate:
                  reference: catalog_attribute["01FCNDV6P870EA6S7TK1DSYD5H"]
                operation_type: navigate
                parse:
                  returns:
                    array: true
                    type: IncidentStatus
                  source: metadata.annotations["github.com/repo"]
            reference: abc123
            root_reference: incident.status
```

--------------------------------

### Workflow Configuration Example

Source: https://docs.incident.io/api-reference/workflows-v2/list

A basic workflow definition including trigger, steps, and execution scope settings.

```yaml
name: My little workflow
            once_for:
              - array: false
                key: incident.custom_field["01FCNDV6P870EA6S7TK1DSYDG0"]
                label: Incident -> Affected Team
                type: IncidentSeverity
            owning_team_ids:
              - 01G0J1EXE7AXZ2C93K61WBPYEH
            private_incident_scope: owning_teams
            runs_from: '2021-08-17T13:28:57.801578Z'
            runs_on_incident_modes:
              - standard
              - test
              - retrospective
            runs_on_incidents: newly_created
            shortform: page-the-ceo
            state: active
            steps:
              - label: PagerDuty Escalate
                name: pagerduty.escalate
            trigger:
              label: Incident Updated
              name: incident.updated
            version: 3
```

--------------------------------

### ErrorDebug Schema Example

Source: https://docs.incident.io/api-reference/workflows-v2/show

Example of the ErrorDebug object containing an error message and stacktrace.

```json
{
  "message": "Something broke: and something else: and something else",
  "stacktrace": [
    "thing.go:123"
  ]
}
```

--------------------------------

### WorkflowsCreateWorkflowPayloadV2 Schema Example

Source: https://docs.incident.io/api-reference/workflows-v2/create

An example payload structure for creating a workflow, demonstrating annotations, condition groups, and expression operations.

```yaml
components:
  schemas:
    WorkflowsCreateWorkflowPayloadV2:
      example:
        annotations:
          incident.io/terraform/version: 3.0.0
        condition_groups:
          - conditions:
              - operation: one_of
                param_bindings:
                  - array_value:
                      - literal: SEV123
                        reference: incident.severity
                    value:
                      literal: SEV123
                      reference: incident.severity
                subject: incident.severity
        continue_on_step_error: true
        delay:
          conditions_apply_over_delay: false
          for_seconds: 60
        expressions:
          - else_branch:
              result:
                array_value:
                  - literal: SEV123
                    reference: incident.severity
                value:
                  literal: SEV123
                  reference: incident.severity
            label: Team Slack channel
            operations:
              - branches:
                  branches:
                    - condition_groups:
                        - conditions:
                            - operation: one_of
                              param_bindings:
                                - array_value:
                                    - literal: SEV123
                                      reference: incident.severity
                                  value:
                                    literal: SEV123
                                    reference: incident.severity
                              subject: incident.severity
                      result:
                        array_value:
                          - literal: SEV123
                            reference: incident.severity
                        value:
                          literal: SEV123
                          reference: incident.severity
                  returns:
                    array: true
                    type: IncidentStatus
                cast:
                  returns:
                    array: true
                    type: IncidentStatus
                concatenate:
                  reference: catalog_attribute["01FCNDV6P870EA6S7TK1DSYD5H"]
                filter:
                  condition_groups:
                    - conditions:
                        - operation: one_of
                          param_bindings:
                            - array_value:
                                - literal: SEV123
                                  reference: incident.severity
                              value:
                                literal: SEV123
                                reference: incident.severity
                          subject: incident.severity
                navigate:
                  reference: catalog_attribute["01FCNDV6P870EA6S7TK1DSYD5H"]
                operation_type: navigate
                parse:
                  returns:
                    array: true
                    type: IncidentStatus
                  source: metadata.annotations["github.com/repo"]
            reference: abc123
            root_reference: incident.status
```

--------------------------------

### Workflow V2 Example Payload

Source: https://docs.incident.io/api-reference/workflows-v2/update

An example of a workflow configuration object including trigger details, steps, and execution modes.

```yaml
- 01G0J1EXE7AXZ2C93K61WBPYEH
          private_incident_scope: owning_teams
          runs_from: '2021-08-17T13:28:57.801578Z'
          runs_on_incident_modes:
            - standard
            - test
            - retrospective
          runs_on_incidents: newly_created
          shortform: page-the-ceo
          state: active
          steps:
            - for_each: abc123
              id: abc123
              label: PagerDuty Escalate
              name: pagerduty.escalate
              param_bindings:
                - array_value:
                    - label: Lawrence Jones
                      literal: SEV123
                      reference: incident.severity
                  value:
                    label: Lawrence Jones
                    literal: SEV123
                    reference: incident.severity
          trigger:
            label: Incident Updated
            name: incident.updated
          version: 3
```

--------------------------------

### Workflow continue_on_step_error example

Source: https://docs.incident.io/api-reference/workflows-v2/update

Example of the boolean flag used to determine if workflow execution should proceed when a step fails.

```yaml
continue_on_step_error:
  description: Whether to continue executing the workflow if a step fails
  example: true
  type: boolean
```

--------------------------------

### GET /v2/workflows

Source: https://docs.incident.io/api-reference/workflows-v2/list

List all workflows configured in the system.

```APIDOC
## GET /v2/workflows

### Description
List all workflows.

### Method
GET

### Endpoint
/v2/workflows

### Response
#### Success Response (200)
- **workflows** (array) - A list of workflow objects.

#### Response Example
{
  "workflows": [
    {
      "condition_groups": [
        {
          "conditions": [
            {
              "operation": {
                "label": "Lawrence Jones",
                "value": "01FCQSP07Z74QMMYPDDGQB9FTG"
              },
              "param_bindings": [
                {
                  "array_value": [
                    {
                      "label": "Lawrence Jones",
                      "literal": "SEV123",
                      "reference": "incident.severity"
                    }
                  ],
                  "value": {
                    "label": "Lawrence Jones",
                    "literal": "SEV123"
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}
```

--------------------------------

### Workflow Expressions Example

Source: https://docs.incident.io/api-reference/workflows-v2/update

Example of complex expression logic within a workflow, including branching and operations.

```yaml
- else_branch:
    result:
      array_value:
        - literal: SEV123
          reference: incident.severity
      value:
        literal: SEV123
        reference: incident.severity
  label: Team Slack channel
  operations:
    - branches:
        branches:
          - condition_groups:
              - conditions:
                  - operation: one_of
                    param_bindings:
                      - array_value:
                          - literal: SEV123
                            reference: incident.severity
                        value:
                          literal: SEV123
                          reference: incident.severity
                    subject: incident.severity
            result:
              array_value:
                - literal: SEV123
                  reference: incident.severity
              value:
                literal: SEV123
                reference: incident.severity
        returns:
          array: true
          type: IncidentStatus
      cast:
        returns:
          array: true
          type: IncidentStatus
      concatenate:
        reference: catalog_attribute["01FCNDV6P870EA6S7TK1DSYD5H"]
      filter:
        condition_groups:
          - conditions:
              - operation: one_of
                param_bindings:
                  - array_value:
                      - literal: SEV123
                        reference: incident.severity
                    value:
                      literal: SEV123
                      reference: incident.severity
                subject: incident.severity
      navigate:
        reference: catalog_attribute["01FCNDV6P870EA6S7TK1DSYD5H"]
      operation_type: navigate
      parse:
        returns:
          array: true
          type: IncidentStatus
        source: metadata.annotations["github.com/repo"]
  reference: abc123
```

--------------------------------

### Workflow expressions example

Source: https://docs.incident.io/api-reference/workflows-v2/update

Example structure for defining expressions that make variables available within the workflow scope.

```yaml
expressions:
  description: Expressions that make variables available in the scope
  example:
    - else_branch:
        result:
          array_value:
            - label: Lawrence Jones
              literal: SEV123
              reference: incident.severity
          value:
            label: Lawrence Jones
            literal: SEV123
            reference: incident.severity
      label: Team Slack channel
      operations:
        - branches:
            branches:
              - condition_groups:
                  - conditions:
                      - operation:
                          label: Lawrence Jones
                          value: 01FCQSP07Z74QMMYPDDGQB9FTG
                        param_bindings:
                          - array_value:
                              - label: Lawrence Jones
                                literal: SEV123
                                reference: incident.severity
                            value:
                              label: Lawrence Jones
                              literal: SEV123
                              reference: incident.severity
                        subject:
                          label: Incident Severity
                          reference: incident.severity
                result:
                  array_value:
                    - label: Lawrence Jones
                      literal: SEV123
                      reference: incident.severity
                  value:
                    label: Lawrence Jones
                    literal: SEV123
                    reference: incident.severity
            returns:
              array: true
              type: IncidentStatus
          cast:
            returns:
              array: true
              type: IncidentStatus
          concatenate:
            reference: '1235'
            reference_label: Teams
          filter:
            condition_groups:
              - conditions:
                  - operation:
                      label: Lawrence Jones
                      value: 01FCQSP07Z74QMMYPDDGQB9FTG
                    param_bindings:
                      - array_value:
                          - label: Lawrence Jones
                            literal: SEV123
                            reference: incident.severity
                        value:
                          label: Lawrence Jones
                          literal: SEV123
                          reference: incident.severity
                    subject:
                      label: Incident Severity
                      reference: incident.severity
          navigate:
            reference: '1235'
            reference_label: Teams
          operation_type: navigate
          parse:
            returns:
              array: true
              type: IncidentStatus
            source: metadata.annotations["github.com/repo"]
          returns:
            array: true
            type: IncidentStatus
      reference: abc123
      returns:
        array: true
        type: IncidentStatus
      root_reference: incident.status
```

--------------------------------

### OpenAPI Workflow Step Configuration

Source: https://docs.incident.io/api-reference/workflows-v2/create

Example of a workflow step configuration including parameter bindings, delay settings, and conditional logic.

```yaml
                            value: 01FCQSP07Z74QMMYPDDGQB9FTG
                          param_bindings:
                            - array_value:
                                - label: Lawrence Jones
                                  literal: SEV123
                                  reference: incident.severity
                              value:
                                label: Lawrence Jones
                                literal: SEV123
                                reference: incident.severity
                          subject:
                            label: Incident Severity
                            reference: incident.severity
                  continue_on_step_error: true
                  delay:
                    conditions_apply_over_delay: false
                    for_seconds: 60
                  expressions:
                    - else_branch:
                        result:
                          array_value:
                            - label: Lawrence Jones
                              literal: SEV123
                              reference: incident.severity
                          value:
                            label: Lawrence Jones
                            literal: SEV123
                            reference: incident.severity
                      label: Team Slack channel
                      operations:
                        - branches:
                            branches:
                              - condition_groups:
                                  - conditions:
                                      - operation:
                                          label: Lawrence Jones
                                          value: 01FCQSP07Z74QMMYPDDGQB9FTG
                                        param_bindings:
                                          - array_value:
                                              - label: Lawrence Jones
                                                literal: SEV123
                                                reference: incident.severity
                                            value:
                                              label: Lawrence Jones
                                              literal: SEV123
                                              reference: incident.severity
                                        subject:
                                          label: Incident Severity
                                          reference: incident.severity
                                result:
                                  array_value:
                                    - label: Lawrence Jones
                                      literal: SEV123
                                      reference: incident.severity
                                  value:
                                    label: Lawrence Jones
                                    literal: SEV123
                                    reference: incident.severity
                            returns:
                              array: true
                              type: IncidentStatus
                          cast:
                            returns:
                              array: true
                              type: IncidentStatus
                          concatenate:
                            reference: '1235'
                            reference_label: Teams
                          filter:
                            condition_groups:
                              - conditions:
                                  - operation:
                                      label: Lawrence Jones
                                      value: 01FCQSP07Z74QMMYPDDGQB9FTG
                                    param_bindings:
                                      - array_value:
                                          - label: Lawrence Jones
                                            literal: SEV123
                                            reference: incident.severity
                                        value:
                                          label: Lawrence Jones
                                          literal: SEV123
                                          reference: incident.severity
                                    subject:
                                      label: Incident Severity
                                      reference: incident.severity
                          navigate:
                            reference: '1235'
                            reference_label: Teams
                          operation_type: navigate
                          parse:
                            returns:
                              array: true
                              type: IncidentStatus
                            source: metadata.annotations["github.com/repo"]
                          returns:
                            array: true
```

--------------------------------

### ErrorSingle Schema Example

Source: https://docs.incident.io/api-reference/workflows-v2/show

Example of a single error response including machine-readable code, message, and source pointer.

```json
{
  "code": "trial_expired",
  "message": "Default incident call link must be a valid URL",
  "metadata": {
    "abc123": "abc123"
  },
  "source": {
    "field": "default_call_url",
    "pointer": "/settings/default_call_url"
  }
}
```

--------------------------------

### ErrorRateLimit Schema Example

Source: https://docs.incident.io/api-reference/workflows-v2/show

Example of a rate limit error response indicating the limit, remaining requests, and retry time.

```json
{
  "limit": 100,
  "name": "client_ip",
  "remaining": 98,
  "retry_after": "2020-01-01T00:00:00Z"
}
```

--------------------------------

### AlertSourceRateLimitShardingV2 Example

Source: https://docs.incident.io/api-reference/alert-sources-v2/show

Example configuration for rate limit sharding using a JSON path key.

```json
{
  "rate_limit_shard_key_path": "$.priority"
}
```

--------------------------------

### ScheduleRotationWorkingIntervalV2 Example

Source: https://docs.incident.io/api-reference/schedules-v2/update

Example object for a working interval, defining the start time, end time, and weekday.

```yaml
example:
  end_time: '17:00'
  start_time: '09:00'
  weekday: monday
```

--------------------------------

### Incident Types List Response Example

Source: https://docs.incident.io/api-reference/incident-types-v1/list

Example JSON response returned by the /v1/incident_types GET request.

```json
{
  "incident_types": [
    {
      "create_in_triage": "always",
      "created_at": "2021-08-17T13:28:57.801578Z",
      "description": "Customer facing production outages",
      "id": "01FCNDV6P870EA6S7TK1DSYDG0",
      "is_default": false,
      "name": "Production Outage",
      "owning_team_ids": [
        "01G0J1EXE7AXZ2C93K61WBPYEH"
      ],
      "private_incidents_only": false,
      "updated_at": "2021-08-17T13:28:57.801578Z"
    }
  ]
}
```

--------------------------------

### ActivityFollowUpRefV2 Example

Source: https://docs.incident.io/api-reference/incident-activity-log-entries-v2/list

Example object for a follow-up reference activity log entry.

```yaml
actor:
          alert:
            id: 01GW2G3V0S59R238FAHPDS1R66
            title: '*errors.withMessage: PG::Error failed to connect'
          api_key:
            id: 01FCNDV6P870EA6S7TK1DSYDG0
            name: My test API key
          user:
            email: lisa@incident.io
            id: 01FCNDV6P870EA6S7TK1DSYDG0
            name: Lisa Karlin Curtis
            role: owner
            slack_user_id: U02AYNF2XJM
          workflow:
            id: 01FCNDV6P870EA6S7TK1DSYDG0
            name: My little workflow
        follow_up_id: 01FCNDV6P870EA6S7TK1DSYDG0
```
Tokens:
Raw