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.
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
The unique identifier of the webhook. Required for the
Webhooks.UpdateWebhook
method.
Webhooks.CreateWebhook
populates the name automatically. Format:
projects/.
display_name
str
Required. The human-readable name of the
webhook, unique within the agent.
google.protobuf.duration_pb2.Duration
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.
[[["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 Webhook (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)\n- [1.41.1](/python/docs/reference/dialogflow-cx/1.41.1/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.40.0](/python/docs/reference/dialogflow-cx/1.40.0/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.39.0](/python/docs/reference/dialogflow-cx/1.39.0/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.38.0](/python/docs/reference/dialogflow-cx/1.38.0/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.37.0](/python/docs/reference/dialogflow-cx/1.37.0/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.36.0](/python/docs/reference/dialogflow-cx/1.36.0/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.35.0](/python/docs/reference/dialogflow-cx/1.35.0/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.34.1](/python/docs/reference/dialogflow-cx/1.34.1/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.33.0](/python/docs/reference/dialogflow-cx/1.33.0/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.32.1](/python/docs/reference/dialogflow-cx/1.32.1/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.31.1](/python/docs/reference/dialogflow-cx/1.31.1/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.30.1](/python/docs/reference/dialogflow-cx/1.30.1/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.29.0](/python/docs/reference/dialogflow-cx/1.29.0/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.28.0](/python/docs/reference/dialogflow-cx/1.28.0/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.27.0](/python/docs/reference/dialogflow-cx/1.27.0/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.26.0](/python/docs/reference/dialogflow-cx/1.26.0/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.25.0](/python/docs/reference/dialogflow-cx/1.25.0/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.24.0](/python/docs/reference/dialogflow-cx/1.24.0/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.23.1](/python/docs/reference/dialogflow-cx/1.23.1/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.22.0](/python/docs/reference/dialogflow-cx/1.22.0/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.21.0](/python/docs/reference/dialogflow-cx/1.21.0/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.20.1](/python/docs/reference/dialogflow-cx/1.20.1/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.19.0](/python/docs/reference/dialogflow-cx/1.19.0/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.18.0](/python/docs/reference/dialogflow-cx/1.18.0/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.17.1](/python/docs/reference/dialogflow-cx/1.17.1/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.16.0](/python/docs/reference/dialogflow-cx/1.16.0/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.15.0](/python/docs/reference/dialogflow-cx/1.15.0/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.14.1](/python/docs/reference/dialogflow-cx/1.14.1/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.13.5](/python/docs/reference/dialogflow-cx/1.13.5/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.12.1](/python/docs/reference/dialogflow-cx/1.12.1/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.11.0](/python/docs/reference/dialogflow-cx/1.11.0/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.10.0](/python/docs/reference/dialogflow-cx/1.10.0/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.9.1](/python/docs/reference/dialogflow-cx/1.9.1/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.8.0](/python/docs/reference/dialogflow-cx/1.8.0/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.7.0](/python/docs/reference/dialogflow-cx/1.7.0/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.6.0](/python/docs/reference/dialogflow-cx/1.6.0/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.5.0](/python/docs/reference/dialogflow-cx/1.5.0/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.4.0](/python/docs/reference/dialogflow-cx/1.4.0/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.3.2](/python/docs/reference/dialogflow-cx/1.3.2/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.2.0](/python/docs/reference/dialogflow-cx/1.2.0/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.1.1](/python/docs/reference/dialogflow-cx/1.1.1/google.cloud.dialogflowcx_v3.types.Webhook)\n- [1.0.0](/python/docs/reference/dialogflow-cx/1.0.0/google.cloud.dialogflowcx_v3.types.Webhook)\n- [0.8.2](/python/docs/reference/dialogflow-cx/0.8.2/google.cloud.dialogflowcx_v3.types.Webhook)\n- [0.7.1](/python/docs/reference/dialogflow-cx/0.7.1/google.cloud.dialogflowcx_v3.types.Webhook)\n- [0.6.0](/python/docs/reference/dialogflow-cx/0.6.0/google.cloud.dialogflowcx_v3.types.Webhook)\n- [0.5.0](/python/docs/reference/dialogflow-cx/0.5.0/google.cloud.dialogflowcx_v3.types.Webhook)\n- [0.4.1](/python/docs/reference/dialogflow-cx/0.4.1/google.cloud.dialogflowcx_v3.types.Webhook)\n- [0.3.0](/python/docs/reference/dialogflow-cx/0.3.0/google.cloud.dialogflowcx_v3.types.Webhook)\n- [0.2.0](/python/docs/reference/dialogflow-cx/0.2.0/google.cloud.dialogflowcx_v3.types.Webhook)\n- [0.1.1](/python/docs/reference/dialogflow-cx/0.1.1/google.cloud.dialogflowcx_v3.types.Webhook) \n\n Webhook(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nWebhooks host the developer's business logic. During a\nsession, webhooks allow the developer to use the data extracted\nby Dialogflow's natural language processing to generate dynamic\nresponses, validate collected data, or trigger actions on the\nbackend.\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### GenericWebService\n\n GenericWebService(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nRepresents configuration for a generic web service.\n\n### ServiceDirectoryConfig\n\n ServiceDirectoryConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nRepresents configuration for a `Service\nDirectory \u003chttps://cloud.google.com/service-directory\u003e`__ service."]]
