The request message for a webhook call. The request is sent
as a JSON object and the field names will be presented in camel
cases.
You may see undocumented fields in an actual request. These
fields are used internally by Dialogflow and should be ignored.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
str
Always present. The unique identifier of the
DetectIntentResponse
that will be returned to the API caller.
text
str
If [natural language
text][google.cloud.dialogflow.cx.v3beta1.TextInput] was
provided as input, this field will contain a copy of the
text.
This field is a member of oneof_ query.
trigger_intent
str
If an
intent was
provided as input, this field will contain a copy of the
intent identifier. Format:
projects/.
This field is a member of oneof_ query.
transcript
str
If [natural language speech
audio][google.cloud.dialogflow.cx.v3beta1.AudioInput] was
provided as input, this field will contain the transcript
for the audio.
This field is a member of oneof_ query.
trigger_event
str
If an event
was provided as input, this field will contain the name of
the event.
This field is a member of oneof_ query.
dtmf_digits
str
If DTMF was
provided as input, this field will contain the DTMF digits.
This field is a member of oneof_ query.
language_code
str
The language code specified in the [original
request][QueryInput.language_code].
MutableSequence[google.cloud.dialogflowcx_v3beta1.types.ResponseMessage]
The list of rich message responses to present to the user.
Webhook can choose to append or replace this list in
WebhookResponse.fulfillment_response;
payload
google.protobuf.struct_pb2.Struct
Custom data set in
QueryParameters.payload.
[[["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 WebhookRequest (1.42.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.42.0 (latest)](/python/docs/reference/dialogflow-cx/latest/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.41.1](/python/docs/reference/dialogflow-cx/1.41.1/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.40.0](/python/docs/reference/dialogflow-cx/1.40.0/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.39.0](/python/docs/reference/dialogflow-cx/1.39.0/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.38.0](/python/docs/reference/dialogflow-cx/1.38.0/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.37.0](/python/docs/reference/dialogflow-cx/1.37.0/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.36.0](/python/docs/reference/dialogflow-cx/1.36.0/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.35.0](/python/docs/reference/dialogflow-cx/1.35.0/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.34.1](/python/docs/reference/dialogflow-cx/1.34.1/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.33.0](/python/docs/reference/dialogflow-cx/1.33.0/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.32.1](/python/docs/reference/dialogflow-cx/1.32.1/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.31.1](/python/docs/reference/dialogflow-cx/1.31.1/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.30.1](/python/docs/reference/dialogflow-cx/1.30.1/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.29.0](/python/docs/reference/dialogflow-cx/1.29.0/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.28.0](/python/docs/reference/dialogflow-cx/1.28.0/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.27.0](/python/docs/reference/dialogflow-cx/1.27.0/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.26.0](/python/docs/reference/dialogflow-cx/1.26.0/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.25.0](/python/docs/reference/dialogflow-cx/1.25.0/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.24.0](/python/docs/reference/dialogflow-cx/1.24.0/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.23.1](/python/docs/reference/dialogflow-cx/1.23.1/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.22.0](/python/docs/reference/dialogflow-cx/1.22.0/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.21.0](/python/docs/reference/dialogflow-cx/1.21.0/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.20.1](/python/docs/reference/dialogflow-cx/1.20.1/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.19.0](/python/docs/reference/dialogflow-cx/1.19.0/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.18.0](/python/docs/reference/dialogflow-cx/1.18.0/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.17.1](/python/docs/reference/dialogflow-cx/1.17.1/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.16.0](/python/docs/reference/dialogflow-cx/1.16.0/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.15.0](/python/docs/reference/dialogflow-cx/1.15.0/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.14.1](/python/docs/reference/dialogflow-cx/1.14.1/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.13.5](/python/docs/reference/dialogflow-cx/1.13.5/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.12.1](/python/docs/reference/dialogflow-cx/1.12.1/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.11.0](/python/docs/reference/dialogflow-cx/1.11.0/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.10.0](/python/docs/reference/dialogflow-cx/1.10.0/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.9.1](/python/docs/reference/dialogflow-cx/1.9.1/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.8.0](/python/docs/reference/dialogflow-cx/1.8.0/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.7.0](/python/docs/reference/dialogflow-cx/1.7.0/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.6.0](/python/docs/reference/dialogflow-cx/1.6.0/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.5.0](/python/docs/reference/dialogflow-cx/1.5.0/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.4.0](/python/docs/reference/dialogflow-cx/1.4.0/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.3.2](/python/docs/reference/dialogflow-cx/1.3.2/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.2.0](/python/docs/reference/dialogflow-cx/1.2.0/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.1.1](/python/docs/reference/dialogflow-cx/1.1.1/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [1.0.0](/python/docs/reference/dialogflow-cx/1.0.0/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [0.8.2](/python/docs/reference/dialogflow-cx/0.8.2/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [0.7.1](/python/docs/reference/dialogflow-cx/0.7.1/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [0.6.0](/python/docs/reference/dialogflow-cx/0.6.0/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [0.5.0](/python/docs/reference/dialogflow-cx/0.5.0/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [0.4.1](/python/docs/reference/dialogflow-cx/0.4.1/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [0.3.0](/python/docs/reference/dialogflow-cx/0.3.0/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [0.2.0](/python/docs/reference/dialogflow-cx/0.2.0/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest)\n- [0.1.1](/python/docs/reference/dialogflow-cx/0.1.1/google.cloud.dialogflowcx_v3beta1.types.WebhookRequest) \n\n WebhookRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nThe request message for a webhook call. The request is sent\nas a JSON object and the field names will be presented in camel\ncases.\n\nYou may see undocumented fields in an actual request. These\nfields are used internally by Dialogflow and should be ignored.\n\nThis message has `oneof`_ fields (mutually exclusive fields).\nFor each oneof, at most one member field can be set at the same time.\nSetting any member of the oneof automatically clears all other\nmembers.\n\n.. _oneof: \u003chttps://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields\u003e\n\nClasses\n-------\n\n### FulfillmentInfo\n\n FulfillmentInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nRepresents fulfillment information communicated to the\nwebhook.\n\n### IntentInfo\n\n IntentInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nRepresents intent information communicated to the webhook.\n\n### SentimentAnalysisResult\n\n SentimentAnalysisResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nRepresents the result of sentiment analysis."]]