Some products and features are in the process of being renamed. Generative playbook and flow features are also being migrated to a single consolidated console. See the details .

PageInfo

JSON representation
FormInfo
- JSON representation
ParameterInfo
- JSON representation

Represents page information communicated to and from the webhook.

JSON representation
{ "currentPage" : string , "displayName" : string , "formInfo" : { object ( `FormInfo` ) } }

Fields

Fields
`currentPage`	`string` Always present for `WebhookRequest` . Ignored for `WebhookResponse` . The unique identifier of the current page. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>` .
`displayName`	`string` Always present for `WebhookRequest` . Ignored for `WebhookResponse` . The display name of the current page.
`formInfo`	`object ( FormInfo )` Optional for both `WebhookRequest` and `WebhookResponse` . Information about the form.

currentPage

string

Always present for WebhookRequest . Ignored for WebhookResponse . The unique identifier of the current page. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID> .

displayName

string

Always present for WebhookRequest . Ignored for WebhookResponse . The display name of the current page.

formInfo

object ( FormInfo )

Optional for both WebhookRequest and WebhookResponse . Information about the form.

FormInfo

Represents form information.

JSON representation
{ "parameterInfo" : [ { object ( `ParameterInfo` ) } ] }

Fields

Fields
`parameterInfo[]`	`object ( ParameterInfo )` Optional for both `WebhookRequest` and `WebhookResponse` . The parameters contained in the form. Note that the webhook cannot add or remove any form parameter.

parameterInfo[]

object ( ParameterInfo )

Optional for both WebhookRequest and WebhookResponse . The parameters contained in the form. Note that the webhook cannot add or remove any form parameter.

ParameterInfo

Represents parameter information.

JSON representation
{ "displayName" : string , "required" : boolean , "state" : enum ( `ParameterState` ) , "value" : value , "justCollected" : boolean }

Fields
`displayName`	`string` Always present for `WebhookRequest` . Required for `WebhookResponse` . The human-readable name of the parameter, unique within the form. This field cannot be modified by the webhook.
`required`	`boolean` Optional for both `WebhookRequest` and `WebhookResponse` . Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.
`state`	`enum ( ParameterState )` Always present for `WebhookRequest` . Required for `WebhookResponse` . The state of the parameter. This field can be set to `INVALID` by the webhook to invalidate the parameter; other values set by the webhook will be ignored.
`value`	`value ( Value format)` Optional for both `WebhookRequest` and `WebhookResponse` . The value of the parameter. This field can be set by the webhook to change the parameter value.
`justCollected`	`boolean` Optional for `WebhookRequest` . Ignored for `WebhookResponse` . Indicates if the parameter value was just collected on the last conversation turn.