# PageInfo

- [JSON representation](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/PageInfo#SCHEMA_REPRESENTATION)
- [FormInfo](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/PageInfo#FormInfo)
  - [JSON representation](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/PageInfo#FormInfo.SCHEMA_REPRESENTATION)
- [ParameterInfo](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/PageInfo#ParameterInfo)
  - [JSON representation](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/PageInfo#ParameterInfo.SCHEMA_REPRESENTATION)

Represents page information communicated to and from the webhook.

| JSON representation |
|---|
| ``` { "currentPage": string, "displayName": string, "formInfo": { object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/PageInfo#FormInfo`) } } ``` |

| Fields ||
|---|---|
| `currentPage` | `string` Always present for `https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/WebhookRequest`. Ignored for `https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/WebhookResponse`. The unique identifier of the current page. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`. |
| `displayName` | `string` Always present for `https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/WebhookRequest`. Ignored for `https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/WebhookResponse`. The display name of the current page. |
| `formInfo` | ``object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/PageInfo#FormInfo`)`` Optional for both `https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/WebhookRequest` and `https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/WebhookResponse`. Information about the form. |

## FormInfo

Represents form information.

| JSON representation |
|---|
| ``` { "parameterInfo": [ { object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/PageInfo#ParameterInfo`) } ] } ``` |

| Fields ||
|---|---|
| `parameterInfo[]` | ``object (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/PageInfo#ParameterInfo`)`` Optional for both `https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/WebhookRequest` and `https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/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 (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/ParameterState`), "value": value, "justCollected": boolean } ``` |

| Fields ||
|---|---|
| `displayName` | `string` Always present for `https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/WebhookRequest`. Required for `https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/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 `https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/WebhookRequest` and `https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/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 (`https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/ParameterState`)`` Always present for `https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/WebhookRequest`. Required for `https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/WebhookResponse`. The state of the parameter. This field can be set to `https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/ParameterState#ENUM_VALUES.INVALID` by the webhook to invalidate the parameter; other values set by the webhook will be ignored. |
| `value` | ``value (`https://protobuf.dev/reference/protobuf/google.protobuf#value` format)`` Optional for both `https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/WebhookRequest` and `https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/WebhookResponse`. The value of the parameter. This field can be set by the webhook to change the parameter value. |
| `justCollected` | `boolean` Optional for `https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/WebhookRequest`. Ignored for `https://docs.cloud.google.com/dialogflow/cx/docs/reference/rest/v3/WebhookResponse`. Indicates if the parameter value was just collected on the last conversation turn. |