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 .

EventHandler

JSON representation

An event handler specifies an event that can be handled during a session. When the specified event happens, the following actions are taken in order:

If there is a triggerFulfillment associated with the event, it will be called.
If there is a targetPage associated with the event, the session will transition into the specified page.
If there is a targetFlow associated with the event, the session will transition into the specified flow.

JSON representation

JSON representation
{ "name" : string , "event" : string , "triggerFulfillment" : { object ( `Fulfillment` ) } , // Union field `target` can be only one of the following: "targetPage" : string , "targetFlow" : string , "targetPlaybook" : string // End of list of possible types for union field `target` . }

 { 
 "name" 
 : 
 string 
 , 
 "event" 
 : 
 string 
 , 
 "triggerFulfillment" 
 : 
 { 
 object (  Fulfillment 
 
) 
 } 
 , 
 // Union field target 
can be only one of the following: 
 "targetPage" 
 : 
 string 
 , 
 "targetFlow" 
 : 
 string 
 , 
 "targetPlaybook" 
 : 
 string 
 // End of list of possible types for union field target 
. 
 }

Fields

name

string

Output only. The unique identifier of this event handler.

event

string

Required. The name of the event to handle.

triggerFulfillment

object ( Fulfillment )

The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks.

Union field target . The target to transition to, either a page in the same host flow (the flow that owns this

 TransitionRoute

), or another flow in the same agent. target can be only one of the following:

targetPage

string

The target page to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID> .

targetFlow

string

The target flow to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID> .

targetPlaybook

string

The target playbook to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID> .

EventHandler Stay organized with collections Save and categorize content based on your preferences.

EventHandler