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

Successful response

Name	Datatype	Description
name	string	The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: projects//locations//agents//webhooks/.
disabled	boolean	Indicates whether the webhook is disabled.
displayName	string	Required. The human-readable name of the webhook, unique within the agent.
genericWebService	object	Configuration for a generic web service. (id: GoogleCloudDialogflowCxV3WebhookGenericWebService)
serviceDirectory	object	Configuration for a Service Directory service. (id: GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfig)
timeout	string (google-duration)	Webhook execution timeout. Execution is considered failed if Dialogflow doesn't receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.

projects_locations_agents_webhooks_list

Successful response

Name	Datatype	Description
name	string	The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: projects//locations//agents//webhooks/.
disabled	boolean	Indicates whether the webhook is disabled.
displayName	string	Required. The human-readable name of the webhook, unique within the agent.
genericWebService	object	Configuration for a generic web service. (id: GoogleCloudDialogflowCxV3WebhookGenericWebService)
serviceDirectory	object	Configuration for a Service Directory service. (id: GoogleCloudDialogflowCxV3WebhookServiceDirectoryConfig)
timeout	string (google-duration)	Webhook execution timeout. Execution is considered failed if Dialogflow doesn't receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.

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		Retrieves the specified webhook.
projects_locations_agents_webhooks_list	select	projectsId, locationsId, agentsId	pageSize, pageToken	Returns the list of all webhooks in the specified agent.
projects_locations_agents_webhooks_create	insert	projectsId, locationsId, agentsId		Creates a webhook in the specified agent.
projects_locations_agents_webhooks_patch	update	projectsId, locationsId, agentsId, webhooksId	updateMask	Updates the specified webhook.
projects_locations_agents_webhooks_delete	delete	projectsId, locationsId, agentsId, webhooksId	force	Deletes the specified webhook.

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

Retrieves the specified webhook.

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

Returns the list of all webhooks in the specified agent.

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

INSERT examples

projects_locations_agents_webhooks_create

Creates a webhook in the specified agent.

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

Manifest

# Description fields are for documentation purposes
- name: webhooks
  props:
    - name: projectsId
      value: string
      description: Required parameter for the webhooks resource.
    - name: locationsId
      value: string
      description: Required parameter for the webhooks resource.
    - name: agentsId
      value: string
      description: Required parameter for the webhooks resource.
    - name: name
      value: string
      description: >
        The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: `projects//locations//agents//webhooks/`.
        
    - name: displayName
      value: string
      description: >
        Required. The human-readable name of the webhook, unique within the agent.
        
    - name: genericWebService
      value: object
      description: >
        Configuration for a generic web service.
        
    - name: serviceDirectory
      value: object
      description: >
        Configuration for a [Service Directory](https://cloud.google.com/service-directory) service.
        
    - name: timeout
      value: string
      description: >
        Webhook execution timeout. Execution is considered failed if Dialogflow doesn't receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds.
        
    - name: disabled
      value: boolean
      description: >
        Indicates whether the webhook is disabled.
        

UPDATE examples

projects_locations_agents_webhooks_patch

Updates the specified webhook.

UPDATE google.dialogflow.webhooks
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__genericWebService = '{{ genericWebService }}',
data__serviceDirectory = '{{ serviceDirectory }}',
data__timeout = '{{ timeout }}',
data__disabled = {{ disabled }}
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

Deletes the specified webhook.

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