NotificationCreateRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/ibm-api-connect/json-schema/ibm-api-connect-notification-create-request-schema.json",
  "title": "NotificationCreateRequest",
  "description": "Request object to create a Jira ticket notification",
  "x-generated": "2026-10-29",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/ibm-api-connect-engagement-api-openapi.yml#/components/schemas/NotificationCreateRequest",
  "type": "object",
  "required": [
    "config_type",
    "destination_id",
    "content"
  ],
  "properties": {
    "config_type": {
      "type": "string",
      "description": "The type of notification destination",
      "enum": [
        "jira"
      ]
    },
    "destination_id": {
      "$ref": "#/$defs/Id"
    },
    "content": {
      "type": "object",
      "description": "The content used to populate the Jira ticket",
      "properties": {
        "overall_assessment": {
          "type": "object",
          "description": "AI-generated assessment of the finding",
          "properties": {
            "summary": {
              "type": "string",
              "description": "Short summary of the finding"
            },
            "ai_severity": {
              "type": "string",
              "description": "AI-assessed severity level (e.g. low, medium, high, critical)"
            },
            "root_cause": {
              "type": "string",
              "description": "AI-identified root cause of the finding"
            }
          }
        },
        "execution_context": {
          "type": "object",
          "description": "Contextual metadata about the finding and its environment",
          "properties": {
            "finding_id": {
              "type": "string",
              "description": "Unique identifier for the finding"
            },
            "api_id": {
              "type": "string",
              "description": "Identifier of the API associated with the finding"
            },
            "notification_message": {
              "type": "string",
              "description": "Human-readable message describing the notification trigger"
            }
          }
        },
        "recommended_actions": {
          "type": "array",
          "description": "Prioritised list of remediation actions",
          "items": {
            "type": "object",
            "properties": {
              "priority": {
                "type": "integer",
                "description": "Numeric priority (1 = highest)"
              },
              "priority_label": {
                "type": "string",
                "description": "Human-readable priority label (e.g. CRITICAL, HIGH)"
              },
              "title": {
                "type": "string",
                "description": "Short title of the recommended action"
              },
              "category": {
                "type": "string",
                "description": "Category of the action (e.g. security, performance)"
              },
              "detailed_explanation": {
                "type": "string",
                "description": "Full explanation of the recommended action"
              },
              "implementation_guidance": {
                "type": "object",
                "description": "Guidance for implementing the action",
                "properties": {
                  "immediate_action": {
                    "type": "string",
                    "description": "Immediate step to take"
                  },
                  "verification": {
                    "type": "string",
                    "description": "How to verify the action was successful"
                  }
                }
              },
              "evidence": {
                "type": "array",
                "description": "Supporting evidence for this action",
                "items": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  },
  "$defs": {
    "Id": {
      "type": "string",
      "description": "ID.",
      "minLength": 1,
      "maxLength": 1000
    }
  }
}