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-03-05 UTC."],[[["The `currentPage` and `displayName` fields are always present in `WebhookRequest` but ignored in `WebhookResponse`, providing the unique identifier and display name of the current page, respectively."],["`FormInfo` is an optional component for both `WebhookRequest` and `WebhookResponse` that contains information about the form."],["`ParameterInfo` details the parameters within a form and is also optional for both `WebhookRequest` and `WebhookResponse`, with webhooks unable to add or remove form parameters."],["The `ParameterInfo` section contains fields like `displayName`, `required`, `state`, `value`, and `justCollected`, which define parameter characteristics, whether they're mandatory, their state, values and if they were just collected."]]],[]]