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.
- Typebot V5
- Typebot V6
- Option 1
- Option 2
Response
Successful response
To save and use for /continueChat requests.
- Text
- Image
- Video
- Audio
- Embed
- Custom embed
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
- Email
- Number
- URL
- Phone number
- Date
- Payment
- Rating
- File
- Picture choice
- File input v5
- Picture choice v5
Actions to execute on the client side
- Script to execute
- Redirect
- Chatwoot
- Google Analytics
- Wait
- Set variable
- Stream OpenAI
- Execute webhook
- Inject start props
- Init Pixel
- Exec stream
- Execute code
Logs that were saved during the last execution
If the typebot contains dynamic avatars, dynamicTheme returns the new avatar URLs whenever their variables are updated.