# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Dialogflow CX API (v3) - Conversational Agents Webhooks API
  version: 1.0.0
extends: openapi/google-dialogflow-webhooks-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/webhooks/{webhooksId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a CX webhook
      effect: read
      questions:
      - Can I see the URL and timeout configured for one of my CX webhooks?
      - Where do I check whether a webhook is disabled?
      instructions:
      - text: Get webhook {webhook} on agent {agent} in project {project}, location {location}.
        slots:
          webhook: path.webhooksId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Show the endpoint and timeout of webhook {webhook}.
        slots:
          webhook: path.webhooksId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/webhooks/{webhooksId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a CX webhook
      effect: destructive
      questions:
      - Can I delete a webhook that fulfillment still points to?
      - What does forcing a webhook deletion do to references?
      instructions:
      - text: Delete webhook {webhook} from agent {agent} in project {project}, location {location}.
        slots:
          webhook: path.webhooksId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Force-delete webhook {webhook} and clear its references.
        slots:
          webhook: path.webhooksId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/webhooks/{webhooksId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a CX webhook
      effect: write
      questions:
      - How do I change the endpoint URL of an existing webhook?
      - Can I temporarily disable a webhook without deleting it?
      instructions:
      - text: Update webhook {webhook} on agent {agent} (project {project}, location {location}) to use service {service}.
        slots:
          webhook: path.webhooksId
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
          service: requestBody.genericWebService
      - text: Set webhook {webhook} disabled to {disabled}.
        slots:
          webhook: path.webhooksId
          disabled: requestBody.disabled
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhooks on a CX agent
      effect: read
      questions:
      - Which webhooks are defined on my CX agent?
      - Can I page through a large set of agent webhooks?
      instructions:
      - text: List the webhooks on agent {agent} in project {project}, location {location}.
        slots:
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Show agent {agent} webhooks, {page_size} per page.
        slots:
          agent: path.agentsId
          page_size: query.pageSize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a webhook on a CX agent
      effect: write
      questions:
      - How do I register a new webhook endpoint for my CX agent?
      - Can I set a request timeout when creating a webhook?
      instructions:
      - text: Create webhook {display_name} on agent {agent} in project {project}, location {location}.
        slots:
          display_name: requestBody.displayName
          agent: path.agentsId
          project: path.projectsId
          location: path.locationsId
      - text: Add a webhook to agent {agent} calling {service} with timeout {timeout}.
        slots:
          agent: path.agentsId
          service: requestBody.genericWebService
          timeout: requestBody.timeout
      method: generated
      generated: '2026-10-01'