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' ")="">
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
Keys and values corresponding to the fields of the message.
mapping
Union[dict, .Message]
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 mapping is a mapping type or there are keyword parameters.
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>__.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Class GenericWebService (1.42.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.42.0 (latest)](/python/docs/reference/dialogflow-cx/latest/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.41.1](/python/docs/reference/dialogflow-cx/1.41.1/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.40.0](/python/docs/reference/dialogflow-cx/1.40.0/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.39.0](/python/docs/reference/dialogflow-cx/1.39.0/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.38.0](/python/docs/reference/dialogflow-cx/1.38.0/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.37.0](/python/docs/reference/dialogflow-cx/1.37.0/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.36.0](/python/docs/reference/dialogflow-cx/1.36.0/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.35.0](/python/docs/reference/dialogflow-cx/1.35.0/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.34.1](/python/docs/reference/dialogflow-cx/1.34.1/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.33.0](/python/docs/reference/dialogflow-cx/1.33.0/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.32.1](/python/docs/reference/dialogflow-cx/1.32.1/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.31.1](/python/docs/reference/dialogflow-cx/1.31.1/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.30.1](/python/docs/reference/dialogflow-cx/1.30.1/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.29.0](/python/docs/reference/dialogflow-cx/1.29.0/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.28.0](/python/docs/reference/dialogflow-cx/1.28.0/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.27.0](/python/docs/reference/dialogflow-cx/1.27.0/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.26.0](/python/docs/reference/dialogflow-cx/1.26.0/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.25.0](/python/docs/reference/dialogflow-cx/1.25.0/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.24.0](/python/docs/reference/dialogflow-cx/1.24.0/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.23.1](/python/docs/reference/dialogflow-cx/1.23.1/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.22.0](/python/docs/reference/dialogflow-cx/1.22.0/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.21.0](/python/docs/reference/dialogflow-cx/1.21.0/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.20.1](/python/docs/reference/dialogflow-cx/1.20.1/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.19.0](/python/docs/reference/dialogflow-cx/1.19.0/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.18.0](/python/docs/reference/dialogflow-cx/1.18.0/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.17.1](/python/docs/reference/dialogflow-cx/1.17.1/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.16.0](/python/docs/reference/dialogflow-cx/1.16.0/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.15.0](/python/docs/reference/dialogflow-cx/1.15.0/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.14.1](/python/docs/reference/dialogflow-cx/1.14.1/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.13.5](/python/docs/reference/dialogflow-cx/1.13.5/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.12.1](/python/docs/reference/dialogflow-cx/1.12.1/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.11.0](/python/docs/reference/dialogflow-cx/1.11.0/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.10.0](/python/docs/reference/dialogflow-cx/1.10.0/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.9.1](/python/docs/reference/dialogflow-cx/1.9.1/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.8.0](/python/docs/reference/dialogflow-cx/1.8.0/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.7.0](/python/docs/reference/dialogflow-cx/1.7.0/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.6.0](/python/docs/reference/dialogflow-cx/1.6.0/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.5.0](/python/docs/reference/dialogflow-cx/1.5.0/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.4.0](/python/docs/reference/dialogflow-cx/1.4.0/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.3.2](/python/docs/reference/dialogflow-cx/1.3.2/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.2.0](/python/docs/reference/dialogflow-cx/1.2.0/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.1.1](/python/docs/reference/dialogflow-cx/1.1.1/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [1.0.0](/python/docs/reference/dialogflow-cx/1.0.0/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [0.8.2](/python/docs/reference/dialogflow-cx/0.8.2/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [0.7.1](/python/docs/reference/dialogflow-cx/0.7.1/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [0.6.0](/python/docs/reference/dialogflow-cx/0.6.0/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [0.5.0](/python/docs/reference/dialogflow-cx/0.5.0/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [0.4.1](/python/docs/reference/dialogflow-cx/0.4.1/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [0.3.0](/python/docs/reference/dialogflow-cx/0.3.0/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [0.2.0](/python/docs/reference/dialogflow-cx/0.2.0/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService)\n- [0.1.1](/python/docs/reference/dialogflow-cx/0.1.1/google.cloud.dialogflowcx_v3.types.Webhook.GenericWebService) \n\n GenericWebService(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nRepresents configuration for a generic web service.\n\nClasses\n-------\n\n### HttpMethod\n\n HttpMethod(value)\n\nHTTP method to use when calling webhooks.\n\n### OAuthConfig\n\n OAuthConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nRepresents configuration of OAuth client credential flow for\n3rd party API authentication.\n\n### ParameterMappingEntry\n\n ParameterMappingEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nThe abstract base class for a message.\n\n### RequestHeadersEntry\n\n RequestHeadersEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nThe abstract base class for a message.\n\n### ServiceAgentAuth\n\n ServiceAgentAuth(value)\n\nIndicate the auth token type generated from the `Diglogflow service\nagent \u003chttps://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent\u003e`__.\n\n### WebhookType\n\n WebhookType(value)\n\nRepresents the type of webhook configuration."]]