# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for BigPanda Notifications API
  version: 1.0.0
extends: openapi/bigpanda-notifications-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['/resources/v2.1/integrations'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhook v2 notification integrations
      effect: read
      questions:
      - Which outbound webhook v2 integrations are sending BigPanda incidents to other tools?
      - Can I see all of our webhook v2 notification configurations at once?
      instructions:
      - text: List all webhook v2 integration configurations.
      - text: Show every outbound webhook v2 notification we have configured.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.1/integrations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a webhook v2 notification integration
      effect: write
      questions:
      - How do I send incident notifications to our ticketing system with a custom webhook payload?
      - Can webhook v2 integrations only be created through the API, not the UI?
      instructions:
      - text: Create a webhook v2 integration named {name} with workflow config {workflow_config}.
        slots:
          name: requestBody.name
          workflow_config: requestBody.workflow_config
      - text: Set up a new outbound webhook v2 integration {name} under parent system {parent_system_id}.
        slots:
          name: requestBody.name
          parent_system_id: requestBody.parent_system_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.1/integrations/{app_key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook v2 integration
      effect: destructive
      questions:
      - Do I need the app key rather than the integration ID to delete a webhook v2 integration?
      - Can I remove an outbound webhook v2 integration we stopped using?
      instructions:
      - text: Delete the webhook v2 integration with app key {app_key}.
        slots:
          app_key: path.app_key
      - text: Remove outbound webhook integration {app_key}.
        slots:
          app_key: path.app_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.1/integrations/{integration_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a webhook v2 integration's configuration
      effect: read
      questions:
      - What triggers and payload does a specific webhook v2 integration use?
      - Can I look up one webhook v2 workflow configuration by integration ID?
      instructions:
      - text: Get webhook v2 configuration {integration_id}.
        slots:
          integration_id: path.integration_id
      - text: Show the workflow config of webhook integration {integration_id}.
        slots:
          integration_id: path.integration_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.1/integrations/{integration_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a webhook v2 integration's workflow
      effect: write
      questions:
      - Can I change the payload or headers of an existing webhook v2 integration?
      - Why does updating a webhook v2 configuration need the full integration ID including the parent?
      instructions:
      - text: Update webhook v2 integration {integration_id} with workflow config {workflow_config}.
        slots:
          integration_id: path.integration_id
          workflow_config: requestBody.workflow_config
      - text: Change the share triggers on webhook integration {integration_id}.
        slots:
          integration_id: path.integration_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.1/fields-resolver/workflows'].get
  update:
    x-apievangelist-phrasing:
      intent: List dynamic variables for webhook templates
      effect: read
      questions:
      - Which incident and alert fields can I use as variables in a webhook payload?
      - What dynamic variables are available for outbound notification templates?
      instructions:
      - text: List the dynamic variables available for webhook v2 templates.
      - text: Show which incident and alert fields I can reference in a notification workflow.
      method: generated
      generated: '2026-09-26'