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.
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>.
Optional for both WebhookRequest and WebhookResponse. The parameters contained in the form. Note that the webhook cannot add or remove any form parameter.
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[[["\u003cp\u003eThis content details the structure of page information exchanged with a webhook, including the current page's identifier, display name, and form details.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eFormInfo\u003c/code\u003e contains an array of \u003ccode\u003eParameterInfo\u003c/code\u003e objects, providing details about the parameters within a form, without the ability to add or remove parameters via the webhook.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eParameterInfo\u003c/code\u003e describes individual parameters within a form, specifying attributes like display name, whether it's required, its current state, and its value.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ecurrentPage\u003c/code\u003e and \u003ccode\u003edisplayName\u003c/code\u003e fields are always present in \u003ccode\u003eWebhookRequest\u003c/code\u003e but are ignored in \u003ccode\u003eWebhookResponse\u003c/code\u003e, whereas \u003ccode\u003eparameterInfo\u003c/code\u003e in \u003ccode\u003eFormInfo\u003c/code\u003e, and fields of \u003ccode\u003eParameterInfo\u003c/code\u003e can be present in both \u003ccode\u003eWebhookRequest\u003c/code\u003e and \u003ccode\u003eWebhookResponse\u003c/code\u003e at times.\u003c/p\u003e\n"],["\u003cp\u003eWebhooks have the ability to modify the \u003ccode\u003estate\u003c/code\u003e and the \u003ccode\u003evalue\u003c/code\u003e of parameters in the \u003ccode\u003eParameterInfo\u003c/code\u003e, and the ability to signal if the parameter was just collected with the field \u003ccode\u003ejustCollected\u003c/code\u003e on \u003ccode\u003eWebhookRequest\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# PageInfo\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [FormInfo](#FormInfo)\n - [JSON representation](#FormInfo.SCHEMA_REPRESENTATION)\n- [ParameterInfo](#ParameterInfo)\n - [JSON representation](#ParameterInfo.SCHEMA_REPRESENTATION)\n\nRepresents page information communicated to and from the webhook.\n\nFormInfo\n--------\n\nRepresents form information.\n\nParameterInfo\n-------------\n\nRepresents parameter information."]]
