Start preview chat
Use this endpoint to test your bot. The answers will not be saved. And some blocks like “Send email” will be skipped.
If set to true
, it will only register the session and not start the bot. This is used for 3rd party chat platforms as it can require a session to be registered before sending the first message.
If set, it will override the typebot that is used to start the chat.
Expiration delay in hours after latest interaction
Path Parameters
Body
If set to true
, it will only register the session and not start the bot. This is used for 3rd party chat platforms as it can require a session to be registered before sending the first message.
If set, it will override the typebot that is used to start the chat.
3
, 4
, 5
Expiration delay in hours after latest interaction
0.01 < x < 48
Top
, Bottom
fixed
, absolute
none
, medium
, large
Response
To save and use for /continueChat requests.
Top
, Bottom
fixed
, absolute
none
, medium
, large
Expiration delay in hours after latest interaction
0.01 < x < 48
The sent message is validated and formatted on the backend. For example, if for a date input you replied something like tomorrow
, the backend will convert it to a date string. This field returns the formatted message.
text input
Actions to execute on the client side
scriptToExecute
If progress bar is enabled, this field will return a number between 0 and 100 indicating the current progress based on the longest remaining path of the flow.