# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Confluent Cloud Integrations (notifications/v1) API
  version: 1.0.0
extends: openapi/confluent-integrations-notifications-v1-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/notifications/v1/integrations'].get
  update:
    x-apievangelist-phrasing:
      intent: List notification integrations
      effect: read
      questions:
      - Which notification integrations are set up for my organization?
      - Can I filter notification integrations by resource type?
      instructions:
      - text: List my notification integrations.
      - text: List notification integrations for resource type {resource_type}.
        slots:
          resource_type: query.resource_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/v1/integrations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a notification integration
      effect: write
      questions:
      - How do I send Confluent Cloud notifications to a webhook or Slack channel?
      - Can I add a Microsoft Teams integration for alerts?
      instructions:
      - text: Create a notification integration named {display_name} targeting {target}.
        slots:
          display_name: requestBody.display_name
          target: requestBody.target
      - text: Add a new webhook notification integration called {display_name}.
        slots:
          display_name: requestBody.display_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/v1/integrations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a notification integration
      effect: read
      questions:
      - What target is a specific notification integration pointing to?
      - Can I view the details of one notification integration?
      instructions:
      - text: Get notification integration {id}.
        slots:
          id: path.id
      - text: Show the settings of integration {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/v1/integrations/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a notification integration
      effect: destructive
      questions:
      - How do I stop sending notifications to an integration I no longer use?
      - Can I remove a Slack notification integration?
      instructions:
      - text: Delete notification integration {id}.
        slots:
          id: path.id
      - text: Remove the integration {id} so it stops receiving notifications.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/v1/integrations/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a notification integration
      effect: write
      questions:
      - Can I change the webhook target of an existing notification integration?
      - How do I rename a notification integration?
      instructions:
      - text: Rename notification integration {id} to {display_name}.
        slots:
          id: path.id
          display_name: requestBody.display_name
      - text: Point existing integration {id} at the new target {target}.
        slots:
          id: path.id
          target: requestBody.target
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/v1/integrations:test'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test notification to an integration
      effect: write
      questions:
      - Is there a way to check my webhook, Slack or Teams integration works before relying on it?
      - What happens when I send a test notification?
      instructions:
      - text: Send a test notification to the integration target {target}.
        slots:
          target: requestBody.target
      - text: Test the notification integration {id} by sending a sample message.
        slots:
          id: requestBody.id
      method: generated
      generated: '2026-09-26'