Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::Webhook (v1.0.0)

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
Returns
  • (::Boolean) — Indicates whether the webhook is disabled.

#disabled=

def disabled=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Indicates whether the webhook is disabled.
Returns
  • (::Boolean) — Indicates whether the webhook is disabled.

#display_name

def display_name() -> ::String
Returns
  • (::String) — Required. The human-readable name of the webhook, unique within the agent.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Required. The human-readable name of the webhook, unique within the agent.
Returns
  • (::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
Returns

#generic_web_service=

def generic_web_service=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Webhook::GenericWebService
Parameter
Returns

#name

def name() -> ::String
Returns
  • (::String) — The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>.
Returns
  • (::String) — The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>.

#service_directory

def service_directory() -> ::Google::Cloud::Dialogflow::CX::V3::Webhook::ServiceDirectoryConfig

#service_directory=

def service_directory=(value) -> ::Google::Cloud::Dialogflow::CX::V3::Webhook::ServiceDirectoryConfig

#timeout

def timeout() -> ::Google::Protobuf::Duration
Returns
  • (::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
Parameter
  • 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.
Returns
  • (::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.