Class Webhook (1.18.0)

Webhook(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Webhooks host the developer's business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow's natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

NameDescription
name str
The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: projects/.
display_name str
Required. The human-readable name of the webhook, unique within the agent.
generic_web_service google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService
Configuration for a generic web service. This field is a member of oneof_ webhook.
service_directory google.cloud.dialogflowcx_v3.types.Webhook.ServiceDirectoryConfig
Configuration for a `Service Directory
timeout google.protobuf.duration_pb2.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.
disabled bool
Indicates whether the webhook is disabled.

Classes

GenericWebService

GenericWebService(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents configuration for a generic web service.

ServiceDirectoryConfig

ServiceDirectoryConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents configuration for a Service Directory <https://cloud.google.com/service-directory>__ service.