Component schema

AgenticWorkflowNotifications

object1 direct reference

Definition

Notification channels to notify when an automation run completes, grouped by outcome. Both lists are optional; omit one to skip notifying on that outcome.

string[]

Notification channels to notify when an automation run completes successfully. Each value is an opaque channel identifier: either the channel's UUID or its origin (the stable identifier infrastructure-as-code tooling assigns). Identifiers are resolved at dispatch time, so an automation authored via Terraform or the operator can reference channels without knowing their per-environment UUID. An empty or absent list notifies no channels on success.

string[]

Notification channels to notify when an automation run fails. Each value is an opaque channel identifier: either the channel's UUID or its origin. An empty or absent list notifies no channels on failure.

string[]

Notification channels to notify when this workflow's rolling credit budget crosses its warning threshold (guardrails.creditBudgetWindow.warningThreshold). Each value is an opaque channel identifier: either the channel's UUID or its origin. An empty or absent list notifies no channels on budget warnings.

Used by 1

These schemas and endpoints reference this type directly.

SchemaAgenticWorkflowSpec

json

OpenAPI source1234567891011121314151617181920212223242526
{
  "description": "Notification channels to notify when an automation run completes, grouped by outcome.\nBoth lists are optional; omit one to skip notifying on that outcome.\n",
  "properties": {
    "onSuccessChannels": {
      "description": "Notification channels to notify when an automation run completes successfully. Each value is an\nopaque channel identifier: either the channel's UUID or its origin (the stable identifier\ninfrastructure-as-code tooling assigns). Identifiers are resolved at dispatch time, so an\nautomation authored via Terraform or the operator can reference channels without knowing their\nper-environment UUID. An empty or absent list notifies no channels on success.\n",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "onFailureChannels": {
      "description": "Notification channels to notify when an automation run fails. Each value is an opaque channel\nidentifier: either the channel's UUID or its origin. An empty or absent list notifies no\nchannels on failure.\n",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "onBudgetWarningChannels": {
      "description": "Notification channels to notify when this workflow's rolling credit budget crosses its\nwarning threshold (`guardrails.creditBudgetWindow.warningThreshold`). Each value is an opaque channel\nidentifier: either the channel's UUID or its origin. An empty or absent list notifies no\nchannels on budget warnings.\n",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}