webhooks

Creates, updates, deletes, gets or lists a webhooks resource.

Overview

Name	webhooks
Type	Resource
Id	google.dialogflow.webhooks

Fields

The following fields are returned by SELECT queries:

projects_locations_agents_webhooks_get

Name	Datatype	Description
name	string
disabled	boolean
displayName	string
genericWebService	object	(id: GoogleCloudDialogflowCxV3WebhookGenericWebService)
serviceDirectory	object	(id: GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfig)
timeout	string (google-duration)

projects_locations_agents_webhooks_list

Name	Datatype	Description
name	string
disabled	boolean
displayName	string
genericWebService	object	(id: GoogleCloudDialogflowCxV3WebhookGenericWebService)
serviceDirectory	object	(id: GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfig)
timeout	string (google-duration)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_agents_webhooks_get	select	projectsId, locationsId, agentsId, webhooksId
projects_locations_agents_webhooks_list	select	projectsId, locationsId, agentsId	pageToken, pageSize
projects_locations_agents_webhooks_create	insert	projectsId, locationsId, agentsId
projects_locations_agents_webhooks_patch	update	projectsId, locationsId, agentsId, webhooksId	updateMask
projects_locations_agents_webhooks_delete	delete	projectsId, locationsId, agentsId, webhooksId	force

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
agentsId	string
locationsId	string
projectsId	string
webhooksId	string
force	boolean
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_agents_webhooks_get

Successful response

SELECT
name,
disabled,
displayName,
genericWebService,
serviceDirectory,
timeout
FROM google.dialogflow.webhooks
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
AND webhooksId = '{{ webhooksId }}' -- required
;

projects_locations_agents_webhooks_list

Successful response

SELECT
name,
disabled,
displayName,
genericWebService,
serviceDirectory,
timeout
FROM google.dialogflow.webhooks
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND agentsId = '{{ agentsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
;

INSERT examples

projects_locations_agents_webhooks_create

No description available.

INSERT INTO google.dialogflow.webhooks (
data__name,
data__genericWebService,
data__displayName,
data__timeout,
data__disabled,
data__serviceDirectory,
projectsId,
locationsId,
agentsId
)
SELECT 
'{{ name }}',
'{{ genericWebService }}',
'{{ displayName }}',
'{{ timeout }}',
{{ disabled }},
'{{ serviceDirectory }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ agentsId }}'
RETURNING
name,
disabled,
displayName,
genericWebService,
serviceDirectory,
timeout
;

Manifest

# Description fields are for documentation purposes
- name: webhooks
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the webhooks resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the webhooks resource.
  - name: agentsId
    value: "{{ agentsId }}"
    description: Required parameter for the webhooks resource.
  - name: name
    value: "{{ name }}"
  - name: genericWebService
    value:
      allowedCaCerts:
        - "{{ allowedCaCerts }}"
      password: "{{ password }}"
      username: "{{ username }}"
      requestHeaders: "{{ requestHeaders }}"
      serviceAgentAuth: "{{ serviceAgentAuth }}"
      parameterMapping: "{{ parameterMapping }}"
      oauthConfig:
        clientSecret: "{{ clientSecret }}"
        clientId: "{{ clientId }}"
        tokenEndpoint: "{{ tokenEndpoint }}"
        scopes:
          - "{{ scopes }}"
        secretVersionForClientSecret: "{{ secretVersionForClientSecret }}"
      webhookType: "{{ webhookType }}"
      secretVersionsForRequestHeaders: "{{ secretVersionsForRequestHeaders }}"
      uri: "{{ uri }}"
      secretVersionForUsernamePassword: "{{ secretVersionForUsernamePassword }}"
      requestBody: "{{ requestBody }}"
      httpMethod: "{{ httpMethod }}"
      serviceAccountAuthConfig:
        serviceAccount: "{{ serviceAccount }}"
  - name: displayName
    value: "{{ displayName }}"
  - name: timeout
    value: "{{ timeout }}"
  - name: disabled
    value: {{ disabled }}
  - name: serviceDirectory
    value:
      service: "{{ service }}"
      genericWebService:
        allowedCaCerts:
          - "{{ allowedCaCerts }}"
        password: "{{ password }}"
        username: "{{ username }}"
        requestHeaders: "{{ requestHeaders }}"
        serviceAgentAuth: "{{ serviceAgentAuth }}"
        parameterMapping: "{{ parameterMapping }}"
        oauthConfig:
          clientSecret: "{{ clientSecret }}"
          clientId: "{{ clientId }}"
          tokenEndpoint: "{{ tokenEndpoint }}"
          scopes:
            - "{{ scopes }}"
          secretVersionForClientSecret: "{{ secretVersionForClientSecret }}"
        webhookType: "{{ webhookType }}"
        secretVersionsForRequestHeaders: "{{ secretVersionsForRequestHeaders }}"
        uri: "{{ uri }}"
        secretVersionForUsernamePassword: "{{ secretVersionForUsernamePassword }}"
        requestBody: "{{ requestBody }}"
        httpMethod: "{{ httpMethod }}"
        serviceAccountAuthConfig:
          serviceAccount: "{{ serviceAccount }}"

UPDATE examples

projects_locations_agents_webhooks_patch

No description available.

UPDATE google.dialogflow.webhooks
SET 
data__name = '{{ name }}',
data__genericWebService = '{{ genericWebService }}',
data__displayName = '{{ displayName }}',
data__timeout = '{{ timeout }}',
data__disabled = {{ disabled }},
data__serviceDirectory = '{{ serviceDirectory }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND agentsId = '{{ agentsId }}' --required
AND webhooksId = '{{ webhooksId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
disabled,
displayName,
genericWebService,
serviceDirectory,
timeout;

DELETE examples

projects_locations_agents_webhooks_delete

No description available.

DELETE FROM google.dialogflow.webhooks
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND agentsId = '{{ agentsId }}' --required
AND webhooksId = '{{ webhooksId }}' --required
AND force = '{{ force }}'
;