Class WebhookResponse

The response message for a webhook call.

This response is validated by the Dialogflow server. If validation fails, an error will be returned in the QueryResult.diagnostic_info field. Setting JSON fields to an empty value with the wrong type is a common error. To avoid this error:

  • Use "" for empty strings
  • Use {} or null for empty objects
  • Use [] or null for empty arrays

For more information, see the Protocol Buffers Language Guide <https://developers.google.com/protocol-buffers/docs/proto3#json>__.

Attributes
NameDescription
strfulfillment_text
Optional. The text response message intended for the end-user. It is recommended to use ``fulfillment_messages.text.text[0]`` instead. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_text sent to the integration or API caller.
Sequence[google.cloud.dialogflow_v2.types.Intent.Message]fulfillment_messages
Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller.
strsource
Optional. A custom field used to identify the webhook source. Arbitrary strings are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_source sent to the integration or API caller.
google.protobuf.struct_pb2.Structpayload
Optional. This field can be used to pass custom data from your webhook to the integration or API caller. Arbitrary JSON objects are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_payload sent to the integration or API caller. This field is also used by the `Google Assistant integration
Sequence[google.cloud.dialogflow_v2.types.Context]output_contexts
Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller.
google.cloud.dialogflow_v2.types.EventInputfollowup_event_input
Optional. Invokes the supplied events. When this field is set, Dialogflow ignores the ``fulfillment_text``, ``fulfillment_messages``, and ``payload`` fields.
Sequence[google.cloud.dialogflow_v2.types.SessionEntityType]session_entity_types
Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session. Setting this data from a webhook overwrites the session entity types that have been set using ``detectIntent``, ``streamingDetectIntent`` or SessionEntityType management methods.

Inheritance

builtins.object > proto.message.Message > WebhookResponse