data_map.webhooks

Name	Type	Description
webhooks	object[]	An array of objects that define external API calls.
webhooks.expressions	object	A list of expressions to be evaluated upon matching.
webhooks.url	string	The endpoint for the external service or API.
webhooks.headers	object	Any necessary headers for the API call.
webhooks.method	string	The HTTP method (GET, POST, etc.) for the API call.
webhooks.output	object	Defines the format or structure of the response from the API.
webhooks.output.action	object[]	A list of actions to be performed upon matching.
webhooks.output.response	string	A static response text or message based on the outcome of the API call.

Valid actions for output.action

Name	Type	Description
SWML	object	A SWML object to be executed.
say	string	A message to be spoken by the AI agent.
stop	boolean	Whether to stop the conversation.
toggle_functions	object[]	Whether to toggle the functions on or off.
toggle_functions.active	boolean	Whether to activate or deactivate the functions. Default is true
toggle_functions.function	object[]	A list of functions to toggle.
back_to_back_functions	boolean	Whether to execute functions back to back. Default is false
set_meta_data	object	A JSON object containing any metadata, as a key-value map.
playback_bg	object	A JSON object containing the audio file to play.
playback_bg.file	string	URL or filepath of the audio file to play.
playback_bg.wait	boolean	Whether to wait for the audio file to finish playing before continuing. Default is false
stop_playback_bg	boolean	Whether to stop the background audio file.
user_input	string	used to inject text into the users queue as if they input the data themselves.
context_switch	object	A JSON object containing the context to switch to. Default is not set.
context_switch.system_prompt	string	The instructions to send to the agent. Default is not set.
context_switch.consolidate	boolean	Whether to consolidate the context. Default is false
context_switch.user_prompt	string	A string serving as simulated user input for the AI Agent. During a context_switch in the AI's prompt, the user_prompt offers the AI pre-established context or guidance. Default is not set