Dialogflow v3 API - Class Webhook.Types.GenericWebService (2.20.0)

public sealed class Webhook.Types.GenericWebService : IMessage<Webhook.Types.GenericWebService>, IEquatable<Webhook.Types.GenericWebService>, IDeepCloneable<Webhook.Types.GenericWebService>, IBufferMessage, IMessage

Reference documentation and code samples for the Dialogflow v3 API class Webhook.Types.GenericWebService.

Represents configuration for a generic web service.

Inheritance

object > Webhook.Types.GenericWebService

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

GenericWebService()

public GenericWebService()

GenericWebService(GenericWebService)

public GenericWebService(Webhook.Types.GenericWebService other)
Parameter
Name Description
other WebhookTypesGenericWebService

Properties

AllowedCaCerts

public RepeatedField<ByteString> AllowedCaCerts { get; }

Optional. Specifies a list of allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command,

   openssl x509 -req -days 200 -in example.com.csr \
     -signkey example.com.key \
     -out example.com.crt \
     -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")
Property Value
Type Description
RepeatedFieldByteString

HttpMethod

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

Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST.

Property Value
Type Description
WebhookTypesGenericWebServiceTypesHttpMethod

OauthConfig

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

Optional. The OAuth configuration of the webhook. If specified, Dialogflow will initiate the OAuth client credential flow to exchange an access token from the 3rd party platform and put it in the auth header.

Property Value
Type Description
WebhookTypesGenericWebServiceTypesOAuthConfig

ParameterMapping

public MapField<string, string> ParameterMapping { get; }

Optional. Maps the values extracted from specific fields of the flexible webhook response into session parameters.

  • Key: session parameter name
  • Value: field path in the webhook response
Property Value
Type Description
MapFieldstringstring

Password

[Obsolete]
public string Password { get; set; }

The password for HTTP Basic authentication.

Property Value
Type Description
string

RequestBody

public string RequestBody { get; set; }

Optional. Defines a custom JSON object as request body to send to flexible webhook.

Property Value
Type Description
string

RequestHeaders

public MapField<string, string> RequestHeaders { get; }

The HTTP request headers to send together with webhook requests.

Property Value
Type Description
MapFieldstringstring

ServiceAgentAuth

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

Optional. Indicate the auth token type generated from the Diglogflow service agent. The generated token is sent in the Authorization header.

Property Value
Type Description
WebhookTypesGenericWebServiceTypesServiceAgentAuth

Uri

public string Uri { get; set; }

Required. The webhook URI for receiving POST requests. It must use https protocol.

Property Value
Type Description
string

Username

[Obsolete]
public string Username { get; set; }

The user name for HTTP Basic authentication.

Property Value
Type Description
string

WebhookType

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

Optional. Type of the webhook.

Property Value
Type Description
WebhookTypesGenericWebServiceTypesWebhookType