public sealed class Webhook : IMessage<Webhook>, IEquatable<Webhook>, IDeepCloneable<Webhook>, IBufferMessage, IMessageReference documentation and code samples for the Dialogflow v3 API 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.
Namespace
Google.Cloud.Dialogflow.Cx.V3Assembly
Google.Cloud.Dialogflow.Cx.V3.dll
Constructors
Webhook()
public Webhook()Webhook(Webhook)
public Webhook(Webhook other)| Parameter | |
|---|---|
| Name | Description |
other |
Webhook |
Properties
Disabled
public bool Disabled { get; set; }Indicates whether the webhook is disabled.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
DisplayName
public string DisplayName { get; set; }Required. The human-readable name of the webhook, unique within the agent.
| Property Value | |
|---|---|
| Type | Description |
string |
|
GenericWebService
public Webhook.Types.GenericWebService GenericWebService { get; set; }Configuration for a generic web service.
| Property Value | |
|---|---|
| Type | Description |
WebhookTypesGenericWebService |
|
Name
public string Name { get; set; }The unique identifier of the webhook.
Required for the
[Webhooks.UpdateWebhook][google.cloud.dialogflow.cx.v3.Webhooks.UpdateWebhook]
method.
[Webhooks.CreateWebhook][google.cloud.dialogflow.cx.v3.Webhooks.CreateWebhook]
populates the name automatically. Format: projects/<Project
ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>.
| Property Value | |
|---|---|
| Type | Description |
string |
|
ServiceDirectory
public Webhook.Types.ServiceDirectoryConfig ServiceDirectory { get; set; }Configuration for a Service Directory service.
| Property Value | |
|---|---|
| Type | Description |
WebhookTypesServiceDirectoryConfig |
|
Timeout
public Duration Timeout { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
Duration |
|
WebhookCase
public Webhook.WebhookOneofCase WebhookCase { get; }| Property Value | |
|---|---|
| Type | Description |
WebhookWebhookOneofCase |
|
WebhookName
public WebhookName WebhookName { get; set; }WebhookName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
WebhookName |
|