Google Dialogflow

Google Dialogflow Webhooks API

The webhooks API from Google Dialogflow — 2 operation(s) for webhooks.

GitHub OpenAPI

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

PATCH /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/webhooks/{webhooksId} Update a CX webhook · Dialogflow projects locations agents webhooks patch #
Ask an LLM
“How do I change the endpoint URL of an existing webhook?”
“Can I temporarily disable a webhook without deleting it?”
Tell an agent
Update webhook {webhook} on agent {agent} (project {project}, location {location}) to use service {service}.
Set webhook {webhook} disabled to {disabled}.
DELETE /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/webhooks/{webhooksId} Delete a CX webhook · Dialogflow projects locations agents webhooks delete #
Ask an LLM
“Can I delete a webhook that fulfillment still points to?”
“What does forcing a webhook deletion do to references?”
Tell an agent destructive · confirm first
Delete webhook {webhook} from agent {agent} in project {project}, location {location}.
Force-delete webhook {webhook} and clear its references.
GET /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/webhooks/{webhooksId} Get a CX webhook · Dialogflow projects locations agents webhooks get #
Ask an LLM
“Can I see the URL and timeout configured for one of my CX webhooks?”
“Where do I check whether a webhook is disabled?”
Tell an agent
Get webhook {webhook} on agent {agent} in project {project}, location {location}.
Show the endpoint and timeout of webhook {webhook}.
POST /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/webhooks Create a webhook on a CX agent · Dialogflow projects locations agents webhooks create #
Ask an LLM
“How do I register a new webhook endpoint for my CX agent?”
“Can I set a request timeout when creating a webhook?”
Tell an agent
Create webhook {display_name} on agent {agent} in project {project}, location {location}.
Add a webhook to agent {agent} calling {service} with timeout {timeout}.
GET /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/webhooks List webhooks on a CX agent · Dialogflow projects locations agents webhooks list #
Ask an LLM
“Which webhooks are defined on my CX agent?”
“Can I page through a large set of agent webhooks?”
Tell an agent
List the webhooks on agent {agent} in project {project}, location {location}.
Show agent {agent} webhooks, {page_size} per page.

Documentation

📖
Documentation
https://cloud.google.com/dialogflow/cx/docs
📖
APIReference
https://cloud.google.com/dialogflow/cx/docs/reference/rest
📖
GettingStarted
https://cloud.google.com/dialogflow/cx/docs/quick/setup
📖
Quickstart
https://cloud.google.com/dialogflow/cx/docs/quick/build-agent
📖
Authentication
https://cloud.google.com/dialogflow/cx/docs/concept/access-control
📖
Documentation
https://cloud.google.com/dialogflow/es/docs
📖
APIReference
https://cloud.google.com/dialogflow/es/docs/reference/rest/v2-overview
📖
GettingStarted
https://cloud.google.com/dialogflow/es/docs/quick/setup
📖
Quickstart
https://cloud.google.com/dialogflow/es/docs/quick/build-agent
📖
Authentication
https://cloud.google.com/dialogflow/es/docs/access-control

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/google-dialogflow/refs/heads/main/openapi/google-dialogflow-webhooks-api-openapi.yml

Other Resources

🔗
Discovery
https://raw.githubusercontent.com/api-evangelist/google-dialogflow/refs/heads/main/discovery/google-dialogflow-v3.json
🔗
Discovery
https://raw.githubusercontent.com/api-evangelist/google-dialogflow/refs/heads/main/discovery/google-dialogflow-v3beta1.json
🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/google-dialogflow/refs/heads/main/grpc/cx-v3/session.proto
🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/google-dialogflow/refs/heads/main/grpc/cx-v3/agent.proto
🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/google-dialogflow/refs/heads/main/grpc/cx-v3/webhook.proto
🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/google-dialogflow/refs/heads/main/grpc/cx-v3/tool.proto
🔗
Pricing
https://cloud.google.com/dialogflow/pricing
🔗
Console
https://dialogflow.cloud.google.com/cx
🔗
Webhooks
https://cloud.google.com/dialogflow/cx/docs/concept/webhook
🔗
Discovery
https://raw.githubusercontent.com/api-evangelist/google-dialogflow/refs/heads/main/discovery/google-dialogflow-v2.json
🔗
Discovery
https://raw.githubusercontent.com/api-evangelist/google-dialogflow/refs/heads/main/discovery/google-dialogflow-v2beta1.json
🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/google-dialogflow/refs/heads/main/grpc/v2/session.proto
🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/google-dialogflow/refs/heads/main/grpc/v2/agent.proto
🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/google-dialogflow/refs/heads/main/grpc/v2/intent.proto
🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/google-dialogflow/refs/heads/main/grpc/v2/webhook.proto
🔗
Console
https://dialogflow.cloud.google.com/
🔗
Webhooks
https://cloud.google.com/dialogflow/es/docs/fulfillment-webhook

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/google-dialogflow:google-dialogflow-webhooks-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

google-dialogflow-webhooks-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Dialogflow CX API (v3) - Conversational Agents Webhooks API
  version: v3
  description: Dialogflow CX (Conversational Agents) builds flow- and playbook-based agents with pages, routes, webhooks, tools, test cases, environments, experiments and data stores. This OpenAPI is a mechanical conversion of the first-party Google Discovery Document served by dialogflow.googleapis.com.
  contact:
    name: Google Cloud
    url: https://cloud.google.com/dialogflow/
  termsOfService: https://cloud.google.com/terms
  license:
    name: Google APIs Terms of Service
    url: https://developers.google.com/terms
  x-discovery-source: https://dialogflow.googleapis.com/$discovery/rest?version=v3
  x-discovery-revision: '20260825'
  x-discovery-id: dialogflow:v3
servers:
- url: https://dialogflow.googleapis.com
  description: Dialogflow API
security:
- OAuth2:
  - https://www.googleapis.com/auth/cloud-platform
  - https://www.googleapis.com/auth/dialogflow
- BearerAuth: []
tags:
- name: Webhooks
paths:
  /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/webhooks/{webhooksId}:
    patch:
      operationId: dialogflow_projects_locations_agents_webhooks_patch
      tags:
      - Webhooks
      parameters:
      - name: projectsId
        in: path
        description: 'Part of `name`. Resource name pattern: `^projects/[^/]+/locations/[^/]+/agents/[^/]+/webhooks/[^/]+$`.'
        required: true
        schema:
          type: string
      - name: locationsId
        in: path
        description: 'Part of `name`. Resource name pattern: `^projects/[^/]+/locations/[^/]+/agents/[^/]+/webhooks/[^/]+$`.'
        required: true
        schema:
          type: string
      - name: agentsId
        in: path
        description: 'Part of `name`. Resource name pattern: `^projects/[^/]+/locations/[^/]+/agents/[^/]+/webhooks/[^/]+$`.'
        required: true
        schema:
          type: string
      - name: webhooksId
        in: path
        description: 'Part of `name`. Resource name pattern: `^projects/[^/]+/locations/[^/]+/agents/[^/]+/webhooks/[^/]+$`.'
        required: true
        schema:
          type: string
      - name: updateMask
        in: query
        schema:
          type: string
      x-discovery-path-template: v3/{name}
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Webhook'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Webhook'
        default:
          description: Error response (google.rpc.Status)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcStatus'
      security:
      - OAuth2:
        - https://www.googleapis.com/auth/cloud-platform
        - https://www.googleapis.com/auth/dialogflow
      - BearerAuth: []
      summary: Dialogflow projects locations agents webhooks patch
      x-summary-source: derived
    delete:
      operationId: dialogflow_projects_locations_agents_webhooks_delete
      tags:
      - Webhooks
      parameters:
      - name: projectsId
        in: path
        description: 'Part of `name`. Resource name pattern: `^projects/[^/]+/locations/[^/]+/agents/[^/]+/webhooks/[^/]+$`.'
        required: true
        schema:
          type: string
      - name: locationsId
        in: path
        description: 'Part of `name`. Resource name pattern: `^projects/[^/]+/locations/[^/]+/agents/[^/]+/webhooks/[^/]+$`.'
        required: true
        schema:
          type: string
      - name: agentsId
        in: path
        description: 'Part of `name`. Resource name pattern: `^projects/[^/]+/locations/[^/]+/agents/[^/]+/webhooks/[^/]+$`.'
        required: true
        schema:
          type: string
      - name: webhooksId
        in: path
        description: 'Part of `name`. Resource name pattern: `^projects/[^/]+/locations/[^/]+/agents/[^/]+/webhooks/[^/]+$`.'
        required: true
        schema:
          type: string
      - name: force
        in: query
        schema:
          type: boolean
      x-discovery-path-template: v3/{name}
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleProtobufEmpty'
        default:
          description: Error response (google.rpc.Status)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcStatus'
      security:
      - OAuth2:
        - https://www.googleapis.com/auth/cloud-platform
        - https://www.googleapis.com/auth/dialogflow
      - BearerAuth: []
      summary: Dialogflow projects locations agents webhooks delete
      x-summary-source: derived
    get:
      operationId: dialogflow_projects_locations_agents_webhooks_get
      tags:
      - Webhooks
      parameters:
      - name: projectsId
        in: path
        description: 'Part of `name`. Resource name pattern: `^projects/[^/]+/locations/[^/]+/agents/[^/]+/webhooks/[^/]+$`.'
        required: true
        schema:
          type: string
      - name: locationsId
        in: path
        description: 'Part of `name`. Resource name pattern: `^projects/[^/]+/locations/[^/]+/agents/[^/]+/webhooks/[^/]+$`.'
        required: true
        schema:
          type: string
      - name: agentsId
        in: path
        description: 'Part of `name`. Resource name pattern: `^projects/[^/]+/locations/[^/]+/agents/[^/]+/webhooks/[^/]+$`.'
        required: true
        schema:
          type: string
      - name: webhooksId
        in: path
        description: 'Part of `name`. Resource name pattern: `^projects/[^/]+/locations/[^/]+/agents/[^/]+/webhooks/[^/]+$`.'
        required: true
        schema:
          type: string
      x-discovery-path-template: v3/{name}
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Webhook'
        default:
          description: Error response (google.rpc.Status)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcStatus'
      security:
      - OAuth2:
        - https://www.googleapis.com/auth/cloud-platform
        - https://www.googleapis.com/auth/dialogflow
      - BearerAuth: []
      summary: Dialogflow projects locations agents webhooks get
      x-summary-source: derived
  /v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/webhooks:
    post:
      operationId: dialogflow_projects_locations_agents_webhooks_create
      tags:
      - Webhooks
      parameters:
      - name: projectsId
        in: path
        description: 'Part of `parent`. Resource name pattern: `^projects/[^/]+/locations/[^/]+/agents/[^/]+$`.'
        required: true
        schema:
          type: string
      - name: locationsId
        in: path
        description: 'Part of `parent`. Resource name pattern: `^projects/[^/]+/locations/[^/]+/agents/[^/]+$`.'
        required: true
        schema:
          type: string
      - name: agentsId
        in: path
        description: 'Part of `parent`. Resource name pattern: `^projects/[^/]+/locations/[^/]+/agents/[^/]+$`.'
        required: true
        schema:
          type: string
      x-discovery-path-template: v3/{parent}/webhooks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Webhook'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Webhook'
        default:
          description: Error response (google.rpc.Status)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcStatus'
      security:
      - OAuth2:
        - https://www.googleapis.com/auth/cloud-platform
        - https://www.googleapis.com/auth/dialogflow
      - BearerAuth: []
      summary: Dialogflow projects locations agents webhooks create
      x-summary-source: derived
    get:
      operationId: dialogflow_projects_locations_agents_webhooks_list
      tags:
      - Webhooks
      parameters:
      - name: projectsId
        in: path
        description: 'Part of `parent`. Resource name pattern: `^projects/[^/]+/locations/[^/]+/agents/[^/]+$`.'
        required: true
        schema:
          type: string
      - name: locationsId
        in: path
        description: 'Part of `parent`. Resource name pattern: `^projects/[^/]+/locations/[^/]+/agents/[^/]+$`.'
        required: true
        schema:
          type: string
      - name: agentsId
        in: path
        description: 'Part of `parent`. Resource name pattern: `^projects/[^/]+/locations/[^/]+/agents/[^/]+$`.'
        required: true
        schema:
          type: string
      - name: pageToken
        in: query
        schema:
          type: string
      - name: pageSize
        in: query
        schema:
          type: integer
          format: int32
      x-discovery-path-template: v3/{parent}/webhooks
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ListWebhooksResponse'
        default:
          description: Error response (google.rpc.Status)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcStatus'
      security:
      - OAuth2:
        - https://www.googleapis.com/auth/cloud-platform
        - https://www.googleapis.com/auth/dialogflow
      - BearerAuth: []
      summary: Dialogflow projects locations agents webhooks list
      x-summary-source: derived
components:
  schemas:
    GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig:
      type: object
      properties:
        serviceAccount:
          type: string
    GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig:
      type: object
      properties:
        secretVersionForClientSecret:
          type: string
        clientSecret:
          type: string
        scopes:
          type: array
          items:
            type: string
        clientId:
          type: string
        tokenEndpoint:
          type: string
    GoogleCloudDialogflowCxV3WebhookGenericWebServiceSecretVersionHeaderValue:
      type: object
      properties:
        secretVersion:
          type: string
    GoogleCloudDialogflowCxV3WebhookGenericWebService:
      type: object
      properties:
        oauthConfig:
          $ref: '#/components/schemas/GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig'
        serviceAccountAuthConfig:
          $ref: '#/components/schemas/GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig'
        allowedCaCerts:
          type: array
          items:
            type: string
            format: byte
        requestBody:
          type: string
        requestHeaders:
          type: object
          additionalProperties:
            type: string
        serviceAgentAuth:
          type: string
          enum:
          - SERVICE_AGENT_AUTH_UNSPECIFIED
          - NONE
          - ID_TOKEN
          - ACCESS_TOKEN
          x-enumDescriptions:
          - ''
          - ''
          - ''
          - ''
        httpMethod:
          type: string
          enum:
          - HTTP_METHOD_UNSPECIFIED
          - POST
          - GET
          - HEAD
          - PUT
          - DELETE
          - PATCH
          - OPTIONS
          x-enumDescriptions:
          - ''
          - ''
          - ''
          - ''
          - ''
          - ''
          - ''
          - ''
        password:
          type: string
        uri:
          type: string
        secretVersionForUsernamePassword:
          type: string
        parameterMapping:
          type: object
          additionalProperties:
            type: string
        username:
          type: string
        secretVersionsForRequestHeaders:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/GoogleCloudDialogflowCxV3WebhookGenericWebServiceSecretVersionHeaderValue'
        webhookType:
          type: string
          enum:
          - WEBHOOK_TYPE_UNSPECIFIED
          - STANDARD
          - FLEXIBLE
          x-enumDescriptions:
          - ''
          - ''
          - ''
    GoogleCloudDialogflowCxV3ListWebhooksResponse:
      type: object
      properties:
        webhooks:
          type: array
          items:
            $ref: '#/components/schemas/GoogleCloudDialogflowCxV3Webhook'
        nextPageToken:
          type: string
    GoogleProtobufEmpty:
      type: object
    GoogleCloudDialogflowCxV3Webhook:
      type: object
      properties:
        genericWebService:
          $ref: '#/components/schemas/GoogleCloudDialogflowCxV3WebhookGenericWebService'
        timeout:
          type: string
        name:
          type: string
        serviceDirectory:
          $ref: '#/components/schemas/GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfig'
        disabled:
          type: boolean
        displayName:
          type: string
    GoogleRpcStatus:
      type: object
      properties:
        message:
          type: string
        code:
          type: integer
          format: int32
        details:
          type: array
          items:
            type: object
            additionalProperties:
              description: Properties of the object. Contains field @type with type URL.
    GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfig:
      type: object
      properties:
        genericWebService:
          $ref: '#/components/schemas/GoogleCloudDialogflowCxV3WebhookGenericWebService'
        service:
          type: string
  securitySchemes:
    OAuth2:
      type: oauth2
      description: Google OAuth 2.0. Scopes are declared per operation in the Discovery Document.
      flows:
        authorizationCode:
          authorizationUrl: https://accounts.google.com/o/oauth2/v2/auth
          tokenUrl: https://oauth2.googleapis.com/token
          scopes:
            https://www.googleapis.com/auth/cloud-platform: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
            https://www.googleapis.com/auth/dialogflow: View, manage and query your Dialogflow agents
    BearerAuth:
      type: http
      scheme: bearer
      description: 'Google OAuth 2.0 access token or service-account-minted bearer token, sent as Authorization: Bearer <token>.'
externalDocs:
  description: Dialogflow CX documentation
  url: https://cloud.google.com/dialogflow/cx/docs