Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class 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.
Generated from protobuf message google.cloud.dialogflow.cx.v3.Webhook
Namespace
Google \ Cloud \ Dialogflow \ Cx \ V3Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
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>
.
↳ display_name
string
Required. The human-readable name of the webhook, unique within the agent.
↳ generic_web_service
↳ service_directory
↳ timeout
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.
↳ disabled
bool
Indicates whether the webhook is disabled.
getName
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
setName
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>
.
var
string
$this
getDisplayName
Required. The human-readable name of the webhook, unique within the agent.
string
setDisplayName
Required. The human-readable name of the webhook, unique within the agent.
var
string
$this
getGenericWebService
Configuration for a generic web service.
hasGenericWebService
setGenericWebService
Configuration for a generic web service.
$this
getServiceDirectory
Configuration for a Service Directory service.
hasServiceDirectory
setServiceDirectory
Configuration for a Service Directory service.
$this
getTimeout
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.
hasTimeout
clearTimeout
setTimeout
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.
$this
getDisabled
Indicates whether the webhook is disabled.
bool
setDisabled
Indicates whether the webhook is disabled.
var
bool
$this
getWebhook
string
