Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Integrations (notifications/v1) API

7 actions 7 updates phrasing extends openapi/confluent-the-data-streaming-platform-integrations-notifications-v1-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Confluent | the Data Streaming Platform's API. It is a proposal applied on top of the contract, not a document Confluent | the Data Streaming Platform publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info

$.paths['/notifications/v1/integrations'].get

$.paths['/notifications/v1/integrations'].post

$.paths['/notifications/v1/integrations/{id}'].get

$.paths['/notifications/v1/integrations/{id}'].delete

$.paths['/notifications/v1/integrations/{id}'].patch

$.paths['/notifications/v1/integrations:test'].post

OpenAPI Overlay

# 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-the-data-streaming-platform-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 configured in my Confluent Cloud org?
      - Can I filter notification integrations by resource type?
      instructions:
      - text: List my notification integrations.
      - text: Show notification integrations for resource {resource} of type {resource_type}.
        slots:
          resource: query.resource
          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 platform notifications to a webhook, Slack or Teams channel?
      - Can I set up a new notification integration with a display name and target?
      instructions:
      - text: Create a notification integration named {display_name} pointing to {target}.
        slots:
          display_name: requestBody.display_name
          target: requestBody.target
      - text: Add a new notification integration {display_name} described as {description}.
        slots:
          display_name: requestBody.display_name
          description: requestBody.description
      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 and settings does one notification integration have?
      - Can I look up a single notification integration by its ID?
      instructions:
      - text: Show notification integration {id}.
        slots:
          id: path.id
      - text: Read the details 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 notifications going to an integration by removing it?
      - Can I delete a notification integration I no longer use?
      instructions:
      - text: Delete notification integration {id}.
        slots:
          id: path.id
      - text: Remove integration {id} from 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 where an existing notification integration sends alerts?
      - How would I rename a notification integration?
      instructions:
      - text: Change the target of existing integration {id} to {target}.
        slots:
          id: path.id
          target: requestBody.target
      - text: Rename notification integration {id} to {display_name}.
        slots:
          id: path.id
          display_name: requestBody.display_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/v1/integrations:test'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test notification
      effect: write
      questions:
      - Can I send a test notification to check my webhook or Slack integration works?
      - Which integration targets support a test notification?
      instructions:
      - text: Send a test notification to target {target}.
        slots:
          target: requestBody.target
      - text: Test the integration {display_name} by firing a sample notification to {target}.
        slots:
          display_name: requestBody.display_name
          target: requestBody.target
      method: generated
      generated: '2026-09-26'