Issue

Field Type Behavior Description
name string OUTPUT_ONLY Resource name (issues/{id})
display_name string   Short display name for the issue
description string   Detailed description of the detected issue
session string   Agent session that detected this issue
create_time timestamp OUTPUT_ONLY When the issue was created
update_time timestamp OUTPUT_ONLY When the issue was last modified
delete_time timestamp OUTPUT_ONLY When the issue was soft-deleted (null if active)

Example

{
  "name": "issues/db80f50ddbf7",
  "displayName": "S3 Timeout Errors Escalating",
  "description": "datafile-optimizer-plan experiencing 2,839 errors/hour (+22.3% from previous hour), representing 71.2% of planner errors. Errors include 'context canceled' and 'operation error S3: HeadObject/GetObject, context deadline exceeded'.",
  "session": "agents/my-monitor/sessions/ses-abc123",
  "createTime": "2026-02-13T01:04:27.924994Z",
  "updateTime": "2026-02-13T01:04:27.924994Z"
}

Issue Notification Policy

Field Type Behavior Description
name string OUTPUT_ONLY Resource name (issue-notification-policies/{id})
description string   Human-readable description of the policy
connections string[]   List of connection resource names (connections/{id}) used for sending notifications
prompt string   Instructions for the notification agent defining routing rules, channel selection, and formatting preferences
state IssueNotificationPolicyState   Current state of the policy
review_reason string   Explanation of why the policy needs review (populated when state is REVIEW_REQUIRED)
planner_session string   Agent session managing the notification planner
create_time timestamp OUTPUT_ONLY When the policy was created
update_time timestamp OUTPUT_ONLY When the policy was last modified
delete_time timestamp OUTPUT_ONLY When the policy was soft-deleted (null if active)
purge_time timestamp OUTPUT_ONLY When the policy is scheduled for permanent deletion

Example

{
  "name": "issue-notification-policies/default",
  "description": "Send notifications to Slack (#alerts) and create Linear issues for all known issues.",
  "connections": [
    "connections/slack-workspace",
    "connections/linear-project"
  ],
  "prompt": "When a known issue is created or updated, send notifications using both channels...",
  "state": "ISSUE_NOTIFICATION_POLICY_STATE_ACTIVE",
  "plannerSession": "agents/issue-notification-planner-agent/sessions/ses-def456",
  "createTime": "2026-02-28T01:09:28.105790Z",
  "updateTime": "2026-03-04T01:34:50.035946Z"
}

Issue Notification Policy State

Value Description
ISSUE_NOTIFICATION_POLICY_STATE_UNSPECIFIED Default value, not used
ISSUE_NOTIFICATION_POLICY_STATE_ACTIVE Policy is active and will send notifications when issues are detected
ISSUE_NOTIFICATION_POLICY_STATE_REVIEW_REQUIRED Policy needs human review before it will send notifications

This site uses Just the Docs, a documentation theme for Jekyll.