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. Seethe details.
Always present forWebhookRequest. Ignored forWebhookResponse. The unique identifier of the current page. Format:projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.
Optional for bothWebhookRequestandWebhookResponse. The parameters contained in the form. Note that the webhook cannot add or remove any form parameter.
Always present forWebhookRequest. Required forWebhookResponse. The human-readable name of the parameter, unique within the form. This field cannot be modified by the webhook.
required
boolean
Optional for bothWebhookRequestandWebhookResponse. 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 forWebhookRequest. Required forWebhookResponse. The state of the parameter. This field can be set toINVALIDby 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\u003eThe \u003ccode\u003ecurrentPage\u003c/code\u003e and \u003ccode\u003edisplayName\u003c/code\u003e fields are always present in \u003ccode\u003eWebhookRequest\u003c/code\u003e but ignored in \u003ccode\u003eWebhookResponse\u003c/code\u003e, providing the unique identifier and display name of the current page, respectively.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eFormInfo\u003c/code\u003e is an optional component for both \u003ccode\u003eWebhookRequest\u003c/code\u003e and \u003ccode\u003eWebhookResponse\u003c/code\u003e that contains information about the form.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eParameterInfo\u003c/code\u003e details the parameters within a form and is also optional for both \u003ccode\u003eWebhookRequest\u003c/code\u003e and \u003ccode\u003eWebhookResponse\u003c/code\u003e, with webhooks unable to add or remove form parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eParameterInfo\u003c/code\u003e section contains fields like \u003ccode\u003edisplayName\u003c/code\u003e, \u003ccode\u003erequired\u003c/code\u003e, \u003ccode\u003estate\u003c/code\u003e, \u003ccode\u003evalue\u003c/code\u003e, and \u003ccode\u003ejustCollected\u003c/code\u003e, which define parameter characteristics, whether they're mandatory, their state, values and if they were just collected.\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."]]
