GenericWebService(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents configuration for a generic web service.
Attributes |
|
---|---|
Name | Description |
uri |
str
Required. The webhook URI for receiving POST requests. It must use https protocol. |
username |
str
The user name for HTTP Basic authentication. |
password |
str
The password for HTTP Basic authentication. |
request_headers |
MutableMapping[str, str]
The HTTP request headers to send together with webhook requests. |
allowed_ca_certs |
MutableSequence[bytes]
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' ")=""> |
oauth_config |
google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService.OAuthConfig
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. |
service_agent_auth |
google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService.ServiceAgentAuth
Optional. Indicate the auth token type generated from the `Diglogflow service agent |
webhook_type |
google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService.WebhookType
Optional. Type of the webhook. |
http_method |
google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService.HttpMethod
Optional. HTTP method for the flexible webhook calls. Standard webhook always uses POST. |
request_body |
str
Optional. Defines a custom JSON object as request body to send to flexible webhook. |
parameter_mapping |
MutableMapping[str, str]
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 |
Classes
HttpMethod
HttpMethod(value)
HTTP method to use when calling webhooks.
OAuthConfig
OAuthConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Represents configuration of OAuth client credential flow for 3rd party API authentication.
ParameterMappingEntry
ParameterMappingEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
Parameters | |
---|---|
Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |
RequestHeadersEntry
RequestHeadersEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
Parameters | |
---|---|
Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |
ServiceAgentAuth
ServiceAgentAuth(value)
Indicate the auth token type generated from the Diglogflow service
agent <https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent>
__.
WebhookType
WebhookType(value)
Represents the type of webhook configuration.