Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Available options:
richText
, markdown
Response
Successful response
messages
(Text · object | Image · object | Video · object | Audio · object | Embed · object | Custom embed · object)[]
required
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.
clientSideActions
(Script to execute · object | Redirect · object | Chatwoot · object | Google Analytics · object | Wait · object | Set variable · object | Stream OpenAI · object | Execute HTTP request · object | Inject start props · object | Init Pixel · object | Exec stream · object | Execute code · object | Listen to webhook · object)[]
Actions to execute on the client side
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.
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.