WebhookResponse

Stay organized with collections Save and categorize content based on your preferences.

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.

JSON representation
{
  "fulfillmentText": string,
  "fulfillmentMessages": [
    {
      object (Message)
    }
  ],
  "source": string,
  "payload": {
    object
  },
  "outputContexts": [
    {
      object (Context)
    }
  ],
  "followupEventInput": {
    object (EventInput)
  },
  "liveAgentHandoff": boolean,
  "endInteraction": boolean,
  "sessionEntityTypes": [
    {
      object (SessionEntityType)
    }
  ]
}
Fields
fulfillmentText

string

Optional. The text response message intended for the end-user. It is recommended to use fulfillmentMessages.text.text[0] instead. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_text sent to the integration or API caller.

fulfillmentMessages[]

object (Message)

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.

source

string

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.

payload

object (Struct format)

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 for rich response messages. See the format definition at Google Assistant Dialogflow webhook format

outputContexts[]

object (Context)

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.

followupEventInput

object (EventInput)

Optional. Invokes the supplied events. When this field is set, Dialogflow ignores the fulfillmentText, fulfillmentMessages, and payload fields.

liveAgentHandoff

boolean

Indicates that a live agent should be brought in to handle the interaction with the user. In most cases, when you set this flag to true, you would also want to set endInteraction to true as well. Default is false.

endInteraction

boolean

Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false.

sessionEntityTypes[]

object (SessionEntityType)

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.