WebhookResponse

The response message for a webhook call.

JSON representation
{
  "fulfillmentResponse": {
    object (FulfillmentResponse)
  },
  "pageInfo": {
    object (PageInfo)
  },
  "sessionInfo": {
    object (SessionInfo)
  },
  "payload": {
    object
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "targetPage": string,
  "targetFlow": string
  // End of mutually exclusive fields.
}
Fields
fulfillmentResponse

object (FulfillmentResponse)

The fulfillment response to send to the user. This field can be omitted by the webhook if it does not intend to send any response to the user.

pageInfo

object (PageInfo)

Information about page status. This field can be omitted by the webhook if it does not intend to modify page status.

sessionInfo

object (SessionInfo)

Information about session status. This field can be omitted by the webhook if it does not intend to modify session status.

payload

object (Struct format)

Value to append directly to QueryResult.webhook_payloads.

The target to transition to. This can be set optionally to indicate an immediate transition to a different page in the same host flow, or a different flow in the same agent. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
targetPage

string

The target page to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.

targetFlow

string

The target flow to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.

End of mutually exclusive fields.

FulfillmentResponse

Represents a fulfillment response to the user.

JSON representation
{
  "messages": [
    {
      object (ResponseMessage)
    }
  ],
  "mergeBehavior": enum (MergeBehavior)
}
Fields
messages[]

object (ResponseMessage)

The list of rich message responses to present to the user.

mergeBehavior

enum (MergeBehavior)

Merge behavior for messages.