Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::Webhook.
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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#disabled
def disabled() -> ::Boolean- (::Boolean) — Indicates whether the webhook is disabled.
#disabled=
def disabled=(value) -> ::Boolean- value (::Boolean) — Indicates whether the webhook is disabled.
- (::Boolean) — Indicates whether the webhook is disabled.
#display_name
def display_name() -> ::String- (::String) — Required. The human-readable name of the webhook, unique within the agent.
#display_name=
def display_name=(value) -> ::String- value (::String) — Required. The human-readable name of the webhook, unique within the agent.
- (::String) — Required. The human-readable name of the webhook, unique within the agent.
#generic_web_service
def generic_web_service() -> ::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService- (::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService) — Configuration for a generic web service.
Note: The following fields are mutually exclusive:
generic_web_service,service_directory. If a field in that set is populated, all other fields in the set will automatically be cleared.
#generic_web_service=
def generic_web_service=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService- value (::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService) — Configuration for a generic web service.
Note: The following fields are mutually exclusive:
generic_web_service,service_directory. If a field in that set is populated, all other fields in the set will automatically be cleared.
- (::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService) — Configuration for a generic web service.
Note: The following fields are mutually exclusive:
generic_web_service,service_directory. If a field in that set is populated, all other fields in the set will automatically be cleared.
#name
def name() -> ::String- (::String) — The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/webhooks/<WebhookID>.
#name=
def name=(value) -> ::String- value (::String) — The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/webhooks/<WebhookID>.
- (::String) — The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/webhooks/<WebhookID>.
#service_directory
def service_directory() -> ::Google::Cloud::Dialogflow::CX::V3::Webhook::ServiceDirectoryConfig- (::Google::Cloud::Dialogflow::CX::V3::Webhook::ServiceDirectoryConfig) — Configuration for a Service Directory service.
Note: The following fields are mutually exclusive:
service_directory,generic_web_service. If a field in that set is populated, all other fields in the set will automatically be cleared.
#service_directory=
def service_directory=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Webhook::ServiceDirectoryConfig- value (::Google::Cloud::Dialogflow::CX::V3::Webhook::ServiceDirectoryConfig) — Configuration for a Service Directory service.
Note: The following fields are mutually exclusive:
service_directory,generic_web_service. If a field in that set is populated, all other fields in the set will automatically be cleared.
- (::Google::Cloud::Dialogflow::CX::V3::Webhook::ServiceDirectoryConfig) — Configuration for a Service Directory service.
Note: The following fields are mutually exclusive:
service_directory,generic_web_service. If a field in that set is populated, all other fields in the set will automatically be cleared.
#timeout
def timeout() -> ::Google::Protobuf::Duration- (::Google::Protobuf::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.
#timeout=
def timeout=(value) -> ::Google::Protobuf::Duration- value (::Google::Protobuf::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.
- (::Google::Protobuf::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.