Class Webhook (2.1.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class Webhook : IMessage<Webhook>, IEquatable<Webhook>, IDeepCloneable<Webhook>, IBufferMessage, IMessage

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.

Inheritance

Object > Webhook

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

Webhook()

public Webhook()

Webhook(Webhook)

public Webhook(Webhook other)
Parameter
NameDescription
otherWebhook

Properties

Disabled

public bool Disabled { get; set; }

Indicates whether the webhook is disabled.

Property Value
TypeDescription
Boolean

DisplayName

public string DisplayName { get; set; }

Required. The human-readable name of the webhook, unique within the agent.

Property Value
TypeDescription
String

GenericWebService

public Webhook.Types.GenericWebService GenericWebService { get; set; }

Configuration for a generic web service.

Property Value
TypeDescription
Webhook.Types.GenericWebService

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/&lt;Project ID>/locations/&lt;Location ID>/agents/&lt;Agent ID>/webhooks/&lt;Webhook ID>.

Property Value
TypeDescription
String

ServiceDirectory

public Webhook.Types.ServiceDirectoryConfig ServiceDirectory { get; set; }

Configuration for a Service Directory service.

Property Value
TypeDescription
Webhook.Types.ServiceDirectoryConfig

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
TypeDescription
Duration

WebhookCase

public Webhook.WebhookOneofCase WebhookCase { get; }
Property Value
TypeDescription
Webhook.WebhookOneofCase

WebhookName

public WebhookName WebhookName { get; set; }

WebhookName-typed view over the Name resource name property.

Property Value
TypeDescription
WebhookName