2022-11-29 10:02:40 +01:00
{
"openapi" : "3.0.3" ,
"info" : {
"title" : "Chat API" ,
"version" : "1.0.0"
} ,
"servers" : [
{
"url" : "https://typebot.io/api/v1"
}
] ,
"paths" : {
2022-12-22 17:02:34 +01:00
"/sendMessage" : {
2022-11-29 10:02:40 +01:00
"post" : {
2023-03-21 13:58:05 +01:00
"operationId" : "query.sendMessage" ,
2022-11-29 10:02:40 +01:00
"summary" : "Send a message" ,
2022-12-22 17:02:34 +01:00
"description" : "To initiate a chat, do not provide a `sessionId` nor a `message`.\n\nContinue the conversation by providing the `sessionId` and the `message` that should answer the previous question.\n\nSet the `isPreview` option to `true` to chat with the non-published version of the typebot." ,
2023-03-09 08:46:36 +01:00
"security" : [
{
"Authorization" : [ ]
}
] ,
2022-11-29 10:02:40 +01:00
"requestBody" : {
"required" : true ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"properties" : {
"message" : {
"type" : "string" ,
2022-12-22 17:02:34 +01:00
"description" : "The answer to the previous chat input. Do not provide it if you are starting a new chat."
2022-11-29 10:02:40 +01:00
} ,
"sessionId" : {
"type" : "string" ,
2022-12-22 17:02:34 +01:00
"description" : "Session ID that you get from the initial chat request to a bot. If not provided, it will create a new session."
2022-11-29 10:02:40 +01:00
} ,
2022-12-22 17:02:34 +01:00
"startParams" : {
"type" : "object" ,
"properties" : {
2023-01-16 12:13:21 +01:00
"typebot" : {
"anyOf" : [
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groups" : {
"type" : "array" ,
"items" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"title" : {
"type" : "string"
} ,
"graphCoordinates" : {
"type" : "object" ,
"properties" : {
"x" : {
"type" : "number"
} ,
"y" : {
"type" : "number"
}
} ,
"required" : [
"x" ,
"y"
] ,
"additionalProperties" : false
} ,
"blocks" : {
"type" : "array" ,
"items" : {
"anyOf" : [
2023-03-14 16:42:12 +01:00
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"start"
]
} ,
"label" : {
"type" : "string"
}
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"label"
] ,
"additionalProperties" : false
} ,
2023-01-16 12:13:21 +01:00
{
"anyOf" : [
{
2023-03-14 16:42:12 +01:00
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"text"
]
} ,
"content" : {
"type" : "object" ,
"properties" : {
"html" : {
"type" : "string"
} ,
"richText" : {
"type" : "array"
} ,
"plainText" : {
"type" : "string"
}
} ,
"required" : [
"html" ,
"richText" ,
"plainText"
] ,
"additionalProperties" : false
}
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"content"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"image"
]
} ,
"content" : {
"type" : "object" ,
"properties" : {
"url" : {
"type" : "string"
}
} ,
"additionalProperties" : false
}
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"content"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"video"
]
} ,
"content" : {
"type" : "object" ,
"properties" : {
"url" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"url" ,
"youtube" ,
"vimeo"
2023-01-16 12:13:21 +01:00
]
2023-03-14 16:42:12 +01:00
}
} ,
"additionalProperties" : false
}
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"content"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"embed"
]
} ,
"content" : {
"type" : "object" ,
"properties" : {
"url" : {
"type" : "string"
2023-01-16 12:13:21 +01:00
} ,
2023-03-14 16:42:12 +01:00
"height" : {
2023-01-16 12:13:21 +01:00
"anyOf" : [
{
2023-03-14 16:42:12 +01:00
"type" : "number"
2023-01-16 12:13:21 +01:00
} ,
2023-03-14 16:42:12 +01:00
{ }
2023-01-16 12:13:21 +01:00
]
}
2023-03-14 16:42:12 +01:00
} ,
"required" : [
"height"
] ,
"additionalProperties" : false
}
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"content"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"audio"
2023-01-16 12:13:21 +01:00
]
} ,
2023-03-14 16:42:12 +01:00
"content" : {
"type" : "object" ,
"properties" : {
"url" : {
"type" : "string"
2023-01-16 12:13:21 +01:00
}
2023-03-14 16:42:12 +01:00
} ,
"additionalProperties" : false
2023-01-16 12:13:21 +01:00
}
2023-03-14 16:42:12 +01:00
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"content"
] ,
"additionalProperties" : false
}
]
} ,
{
"anyOf" : [
2023-01-16 12:13:21 +01:00
{
2023-03-14 16:42:12 +01:00
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"text input"
2023-01-16 12:13:21 +01:00
]
} ,
2023-03-14 16:42:12 +01:00
"options" : {
"type" : "object" ,
"properties" : {
"labels" : {
2023-01-16 12:13:21 +01:00
"type" : "object" ,
"properties" : {
2023-03-14 16:42:12 +01:00
"placeholder" : {
2023-01-16 12:13:21 +01:00
"type" : "string"
} ,
2023-03-14 16:42:12 +01:00
"button" : {
2023-01-16 12:13:21 +01:00
"type" : "string"
}
} ,
"required" : [
2023-03-14 16:42:12 +01:00
"placeholder" ,
"button"
2023-01-16 12:13:21 +01:00
] ,
"additionalProperties" : false
} ,
2023-03-14 16:42:12 +01:00
"variableId" : {
"type" : "string"
} ,
"isLong" : {
"type" : "boolean"
2023-01-16 12:13:21 +01:00
}
2023-03-14 16:42:12 +01:00
} ,
"required" : [
"labels" ,
"isLong"
] ,
"additionalProperties" : false
2023-01-16 12:13:21 +01:00
}
2023-03-14 16:42:12 +01:00
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"options"
] ,
"additionalProperties" : false
} ,
2023-01-16 12:13:21 +01:00
{
2023-03-14 16:42:12 +01:00
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"choice input"
2023-01-16 12:13:21 +01:00
]
} ,
2023-03-14 16:42:12 +01:00
"items" : {
"type" : "array" ,
"items" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
2023-01-16 12:13:21 +01:00
} ,
2023-03-14 16:42:12 +01:00
"blockId" : {
"type" : "string"
2023-01-16 12:13:21 +01:00
} ,
2023-03-14 16:42:12 +01:00
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "number" ,
"enum" : [
0
]
} ,
"content" : {
"type" : "string"
}
} ,
"required" : [
"id" ,
"blockId" ,
"type"
] ,
"additionalProperties" : false
}
} ,
"options" : {
"type" : "object" ,
"properties" : {
"variableId" : {
"type" : "string"
} ,
"isMultipleChoice" : {
"type" : "boolean"
} ,
"buttonLabel" : {
"type" : "string"
} ,
"dynamicVariableId" : {
"type" : "string"
2023-01-16 12:13:21 +01:00
}
2023-03-14 16:42:12 +01:00
} ,
"required" : [
"isMultipleChoice" ,
"buttonLabel"
] ,
"additionalProperties" : false
2023-01-16 12:13:21 +01:00
}
2023-03-14 16:42:12 +01:00
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"items" ,
"options"
] ,
"additionalProperties" : false
2023-01-16 12:13:21 +01:00
} ,
{
2023-03-09 08:46:36 +01:00
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
2023-01-16 12:13:21 +01:00
} ,
2023-03-09 08:46:36 +01:00
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
2023-03-14 16:42:12 +01:00
"email input"
2023-03-09 08:46:36 +01:00
]
} ,
"options" : {
2023-03-14 16:42:12 +01:00
"type" : "object" ,
"properties" : {
"variableId" : {
"type" : "string"
} ,
"labels" : {
2023-03-09 08:46:36 +01:00
"type" : "object" ,
"properties" : {
2023-03-14 16:42:12 +01:00
"placeholder" : {
"type" : "string"
2023-03-09 08:46:36 +01:00
} ,
2023-03-14 16:42:12 +01:00
"button" : {
2023-03-09 08:46:36 +01:00
"type" : "string"
}
} ,
2023-03-14 16:42:12 +01:00
"required" : [
"placeholder" ,
"button"
] ,
2023-03-09 08:46:36 +01:00
"additionalProperties" : false
2023-01-16 12:13:21 +01:00
} ,
2023-03-14 16:42:12 +01:00
"retryMessageContent" : {
"type" : "string"
}
} ,
"required" : [
"labels" ,
"retryMessageContent"
] ,
"additionalProperties" : false
}
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"options"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"number input"
]
} ,
"options" : {
"type" : "object" ,
"properties" : {
"variableId" : {
"type" : "string"
} ,
"labels" : {
"type" : "object" ,
"properties" : {
"placeholder" : {
"type" : "string"
2023-03-09 08:46:36 +01:00
} ,
2023-03-14 16:42:12 +01:00
"button" : {
2023-01-16 12:13:21 +01:00
"type" : "string"
2023-03-09 08:46:36 +01:00
}
} ,
"required" : [
2023-03-14 16:42:12 +01:00
"placeholder" ,
"button"
2023-03-09 08:46:36 +01:00
] ,
"additionalProperties" : false
} ,
2023-03-14 16:42:12 +01:00
"min" : {
"type" : "number"
} ,
"max" : {
"type" : "number"
} ,
"step" : {
"type" : "number"
}
} ,
"required" : [
"labels"
] ,
"additionalProperties" : false
}
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"options"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"url input"
]
} ,
"options" : {
"type" : "object" ,
"properties" : {
"variableId" : {
"type" : "string"
} ,
"labels" : {
2023-03-09 08:46:36 +01:00
"type" : "object" ,
"properties" : {
2023-03-14 16:42:12 +01:00
"placeholder" : {
2023-01-16 12:13:21 +01:00
"type" : "string"
} ,
2023-03-14 16:42:12 +01:00
"button" : {
2023-03-09 08:46:36 +01:00
"type" : "string"
2023-01-16 12:13:21 +01:00
}
} ,
"required" : [
2023-03-14 16:42:12 +01:00
"placeholder" ,
"button"
2023-01-16 12:13:21 +01:00
] ,
"additionalProperties" : false
2023-03-14 16:42:12 +01:00
} ,
"retryMessageContent" : {
"type" : "string"
2023-01-16 12:13:21 +01:00
}
2023-03-14 16:42:12 +01:00
} ,
"required" : [
"labels" ,
"retryMessageContent"
] ,
"additionalProperties" : false
2023-01-16 12:13:21 +01:00
}
2023-03-09 08:46:36 +01:00
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"options"
] ,
"additionalProperties" : false
2023-03-14 16:42:12 +01:00
} ,
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"phone number input"
]
} ,
"options" : {
"type" : "object" ,
"properties" : {
"variableId" : {
"type" : "string"
} ,
"labels" : {
"type" : "object" ,
"properties" : {
"placeholder" : {
"type" : "string"
} ,
"button" : {
"type" : "string"
}
} ,
"required" : [
"placeholder" ,
"button"
] ,
"additionalProperties" : false
} ,
"retryMessageContent" : {
"type" : "string"
} ,
"defaultCountryCode" : {
"type" : "string"
}
} ,
"required" : [
"labels" ,
"retryMessageContent"
] ,
"additionalProperties" : false
}
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"options"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"date input"
]
} ,
"options" : {
"type" : "object" ,
"properties" : {
"variableId" : {
"type" : "string"
} ,
"labels" : {
"type" : "object" ,
"properties" : {
"button" : {
"type" : "string"
} ,
"from" : {
"type" : "string"
} ,
"to" : {
"type" : "string"
}
} ,
"required" : [
"button" ,
"from" ,
"to"
] ,
"additionalProperties" : false
} ,
"hasTime" : {
"type" : "boolean"
} ,
"isRange" : {
"type" : "boolean"
}
} ,
"required" : [
"labels" ,
"hasTime" ,
"isRange"
] ,
"additionalProperties" : false
}
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"options"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"payment input"
]
} ,
"options" : {
"type" : "object" ,
"properties" : {
"variableId" : {
"type" : "string"
} ,
"provider" : {
"type" : "string" ,
"enum" : [
"Stripe"
]
} ,
"labels" : {
"type" : "object" ,
"properties" : {
"button" : {
"type" : "string"
} ,
"success" : {
"type" : "string"
}
} ,
"required" : [
"button"
] ,
"additionalProperties" : false
} ,
"additionalInformation" : {
"type" : "object" ,
"properties" : {
2023-03-29 16:33:06 +02:00
"description" : {
"type" : "string"
} ,
2023-03-14 16:42:12 +01:00
"name" : {
"type" : "string"
} ,
"email" : {
"type" : "string"
} ,
"phoneNumber" : {
"type" : "string"
}
} ,
"additionalProperties" : false
} ,
"credentialsId" : {
"type" : "string"
} ,
"currency" : {
"type" : "string"
} ,
"amount" : {
"type" : "string"
}
} ,
"required" : [
"provider" ,
"labels" ,
"currency"
] ,
"additionalProperties" : false
}
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"options"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"rating input"
]
} ,
"options" : {
"type" : "object" ,
"properties" : {
"variableId" : {
"type" : "string"
} ,
"buttonType" : {
"anyOf" : [
{
"type" : "string" ,
"enum" : [
"Icons"
]
} ,
{
"type" : "string" ,
"enum" : [
"Numbers"
]
}
]
} ,
"length" : {
"type" : "number"
} ,
"labels" : {
"type" : "object" ,
"properties" : {
"left" : {
"type" : "string"
} ,
"right" : {
"type" : "string"
} ,
"button" : {
"type" : "string"
}
} ,
"required" : [
"button"
] ,
"additionalProperties" : false
} ,
"customIcon" : {
"type" : "object" ,
"properties" : {
"isEnabled" : {
"type" : "boolean"
} ,
"svg" : {
"type" : "string"
}
} ,
"required" : [
"isEnabled"
] ,
"additionalProperties" : false
} ,
"isOneClickSubmitEnabled" : {
"type" : "boolean"
}
} ,
"required" : [
"buttonType" ,
"length" ,
"labels" ,
"customIcon"
] ,
"additionalProperties" : false
}
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"options"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"file input"
]
} ,
"options" : {
"type" : "object" ,
"properties" : {
"variableId" : {
"type" : "string"
} ,
"isRequired" : {
"type" : "boolean"
} ,
"isMultipleAllowed" : {
"type" : "boolean"
} ,
"labels" : {
"type" : "object" ,
"properties" : {
"placeholder" : {
"type" : "string"
} ,
"button" : {
"type" : "string"
} ,
"clear" : {
"type" : "string"
} ,
"skip" : {
"type" : "string"
}
} ,
"required" : [
"placeholder" ,
"button"
] ,
"additionalProperties" : false
} ,
"sizeLimit" : {
"type" : "number"
}
} ,
"required" : [
"isMultipleAllowed" ,
"labels"
] ,
"additionalProperties" : false
}
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"options"
] ,
"additionalProperties" : false
}
]
2023-01-16 12:13:21 +01:00
} ,
{
2023-03-14 16:42:12 +01:00
"anyOf" : [
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"Code"
]
} ,
"options" : {
"type" : "object" ,
"properties" : {
"name" : {
"type" : "string"
} ,
"content" : {
"type" : "string"
} ,
"shouldExecuteInParentContext" : {
"type" : "boolean"
}
} ,
"required" : [
"name"
] ,
"additionalProperties" : false
}
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"options"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"Condition"
]
} ,
"items" : {
"type" : "array" ,
"items" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"blockId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "number" ,
"enum" : [
1
]
} ,
"content" : {
"type" : "object" ,
"properties" : {
"logicalOperator" : {
"type" : "string" ,
"enum" : [
"OR" ,
"AND"
]
} ,
"comparisons" : {
"type" : "array" ,
"items" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"variableId" : {
"type" : "string"
} ,
"comparisonOperator" : {
"type" : "string" ,
"enum" : [
"Equal to" ,
"Not equal" ,
"Contains" ,
2023-03-29 16:33:06 +02:00
"Does not contain" ,
2023-03-14 16:42:12 +01:00
"Greater than" ,
"Less than" ,
2023-03-29 16:33:06 +02:00
"Is set" ,
"Is empty" ,
"Starts with" ,
"Ends with"
2023-03-14 16:42:12 +01:00
]
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"id"
] ,
"additionalProperties" : false
}
}
} ,
"required" : [
"logicalOperator" ,
"comparisons"
] ,
"additionalProperties" : false
}
} ,
"required" : [
"id" ,
"blockId" ,
"type" ,
"content"
] ,
"additionalProperties" : false
}
}
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"items"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"Redirect"
]
} ,
"options" : {
"type" : "object" ,
"properties" : {
"url" : {
"type" : "string"
} ,
"isNewTab" : {
"type" : "boolean"
}
} ,
"required" : [
"isNewTab"
] ,
"additionalProperties" : false
}
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"options"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"Set variable"
]
} ,
"options" : {
"type" : "object" ,
"properties" : {
"variableId" : {
"type" : "string"
} ,
"expressionToEvaluate" : {
"type" : "string"
} ,
"isCode" : {
"type" : "boolean"
}
} ,
"additionalProperties" : false
}
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"options"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"Typebot link"
]
} ,
"options" : {
"type" : "object" ,
"properties" : {
"typebotId" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
}
} ,
"additionalProperties" : false
}
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"options"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"Wait"
]
} ,
"options" : {
"type" : "object" ,
"properties" : {
"secondsToWaitFor" : {
"type" : "string"
}
} ,
"additionalProperties" : false
}
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"options"
] ,
"additionalProperties" : false
2023-01-16 12:13:21 +01:00
} ,
2023-03-14 16:42:12 +01:00
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"Jump"
]
} ,
"options" : {
"type" : "object" ,
"properties" : {
"groupId" : {
"type" : "string"
} ,
"blockId" : {
"type" : "string"
}
} ,
"additionalProperties" : false
}
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"options"
] ,
"additionalProperties" : false
2023-01-16 12:13:21 +01:00
}
2023-03-14 16:42:12 +01:00
]
2023-01-16 12:13:21 +01:00
} ,
{
2023-03-14 16:42:12 +01:00
"anyOf" : [
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"Chatwoot"
]
} ,
"options" : {
"type" : "object" ,
"properties" : {
"task" : {
"type" : "string" ,
"enum" : [
"Show widget" ,
"Close widget"
]
} ,
"baseUrl" : {
"type" : "string"
} ,
"websiteToken" : {
"type" : "string"
} ,
"user" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"email" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"avatarUrl" : {
"type" : "string"
} ,
"phoneNumber" : {
"type" : "string"
}
} ,
"additionalProperties" : false
}
} ,
"required" : [
"baseUrl" ,
"websiteToken"
] ,
"additionalProperties" : false
}
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"options"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"Google Analytics"
]
} ,
"options" : {
"type" : "object" ,
"properties" : {
"trackingId" : {
"type" : "string"
} ,
"category" : {
"type" : "string"
} ,
"action" : {
"type" : "string"
} ,
"label" : {
"type" : "string"
} ,
"value" : {
"type" : "number"
}
} ,
"additionalProperties" : false
}
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"options"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"Google Sheets"
]
} ,
"options" : {
"anyOf" : [
{
"type" : "object" ,
"properties" : {
"credentialsId" : {
"type" : "string"
} ,
"sheetId" : {
"type" : "string"
} ,
"spreadsheetId" : {
"type" : "string"
} ,
"action" : {
"type" : "string" ,
"enum" : [
"Get data from sheet"
]
} ,
"referenceCell" : {
"type" : "object" ,
"properties" : {
"column" : {
"type" : "string"
} ,
"value" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
}
} ,
"required" : [
"id"
] ,
"additionalProperties" : false
} ,
"filter" : {
"type" : "object" ,
"properties" : {
"comparisons" : {
"type" : "array" ,
"items" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"column" : {
"type" : "string"
} ,
"comparisonOperator" : {
"type" : "string" ,
"enum" : [
"Equal to" ,
"Not equal" ,
"Contains" ,
2023-03-29 16:33:06 +02:00
"Does not contain" ,
2023-03-14 16:42:12 +01:00
"Greater than" ,
"Less than" ,
2023-03-29 16:33:06 +02:00
"Is set" ,
"Is empty" ,
"Starts with" ,
"Ends with"
2023-03-14 16:42:12 +01:00
]
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"id"
] ,
"additionalProperties" : false
}
} ,
"logicalOperator" : {
"type" : "string" ,
"enum" : [
"OR" ,
"AND"
]
}
} ,
"required" : [
"comparisons" ,
"logicalOperator"
] ,
"additionalProperties" : false
} ,
"cellsToExtract" : {
"type" : "array" ,
"items" : {
"type" : "object" ,
"properties" : {
"column" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
} ,
"variableId" : {
"type" : "string"
}
} ,
"required" : [
"id"
] ,
"additionalProperties" : false
}
}
} ,
"required" : [
"action" ,
"cellsToExtract"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"credentialsId" : {
"type" : "string"
} ,
"sheetId" : {
"type" : "string"
} ,
"spreadsheetId" : {
"type" : "string"
} ,
"action" : {
"type" : "string" ,
"enum" : [
"Insert a row"
]
} ,
"cellsToInsert" : {
"type" : "array" ,
"items" : {
"type" : "object" ,
"properties" : {
"column" : {
"type" : "string"
} ,
"value" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
}
} ,
"required" : [
"id"
] ,
"additionalProperties" : false
}
}
} ,
"required" : [
"action" ,
"cellsToInsert"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"credentialsId" : {
"type" : "string"
} ,
"sheetId" : {
"type" : "string"
} ,
"spreadsheetId" : {
"type" : "string"
} ,
"action" : {
"type" : "string" ,
"enum" : [
"Update a row"
]
} ,
"cellsToUpsert" : {
"type" : "array" ,
"items" : {
"type" : "object" ,
"properties" : {
"column" : {
"type" : "string"
} ,
"value" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
}
} ,
"required" : [
"id"
] ,
"additionalProperties" : false
}
} ,
"referenceCell" : {
"type" : "object" ,
"properties" : {
"column" : {
"type" : "string"
} ,
"value" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
}
} ,
"required" : [
"id"
] ,
"additionalProperties" : false
}
} ,
"required" : [
"action" ,
"cellsToUpsert"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"credentialsId" : {
"type" : "string"
} ,
"sheetId" : {
"type" : "string"
} ,
"spreadsheetId" : {
"type" : "string"
} ,
"action" : {
"not" : { }
}
} ,
"additionalProperties" : false
}
]
}
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"options"
] ,
"additionalProperties" : false
2023-01-27 10:54:59 +01:00
} ,
2023-03-14 16:42:12 +01:00
{
2023-01-27 10:54:59 +01:00
"type" : "object" ,
"properties" : {
2023-03-14 16:42:12 +01:00
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
2023-01-27 10:54:59 +01:00
"type" : "string"
} ,
2023-03-14 16:42:12 +01:00
"type" : {
"type" : "string" ,
"enum" : [
"Make.com"
]
} ,
"options" : {
"type" : "object" ,
"properties" : {
"variablesForTest" : {
"type" : "array" ,
"items" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"variableId" : {
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"id"
] ,
"additionalProperties" : false
}
} ,
"responseVariableMapping" : {
"type" : "array" ,
"items" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"variableId" : {
"type" : "string"
} ,
"bodyPath" : {
"type" : "string"
}
} ,
"required" : [
"id"
] ,
"additionalProperties" : false
}
} ,
"isAdvancedConfig" : {
"type" : "boolean"
} ,
"isCustomBody" : {
"type" : "boolean"
}
} ,
"required" : [
"variablesForTest" ,
"responseVariableMapping"
] ,
"additionalProperties" : false
} ,
"webhookId" : {
2023-01-27 10:54:59 +01:00
"type" : "string"
}
} ,
"required" : [
2023-03-14 16:42:12 +01:00
"id" ,
"groupId" ,
"type" ,
"options" ,
"webhookId"
2023-01-27 10:54:59 +01:00
] ,
"additionalProperties" : false
2022-11-29 10:02:40 +01:00
} ,
2023-03-14 16:42:12 +01:00
{
2023-01-27 10:54:59 +01:00
"type" : "object" ,
"properties" : {
2023-03-14 16:42:12 +01:00
"id" : {
2023-01-27 10:54:59 +01:00
"type" : "string"
2023-03-14 16:42:12 +01:00
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"OpenAI"
]
} ,
"options" : {
"anyOf" : [
{
"type" : "object" ,
"properties" : {
"task" : {
"not" : { }
} ,
"credentialsId" : {
"type" : "string"
}
} ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"task" : {
"type" : "string" ,
"enum" : [
"Create chat completion"
]
} ,
"model" : {
"type" : "string" ,
"enum" : [
2023-03-21 13:58:05 +01:00
"gpt-4" ,
"gpt-4-0314" ,
"gpt-4-32k" ,
"gpt-4-32k-0314" ,
2023-03-14 16:42:12 +01:00
"gpt-3.5-turbo" ,
"gpt-3.5-turbo-0301"
]
} ,
"messages" : {
"type" : "array" ,
"items" : {
"anyOf" : [
2022-11-29 10:02:40 +01:00
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
2023-03-14 16:42:12 +01:00
"role" : {
2022-11-29 10:02:40 +01:00
"type" : "string" ,
"enum" : [
2023-03-14 16:42:12 +01:00
"system" ,
"user" ,
"assistant"
2022-11-29 10:02:40 +01:00
]
} ,
2023-03-14 16:42:12 +01:00
"content" : {
"type" : "string"
2022-11-29 10:02:40 +01:00
}
} ,
"required" : [
2023-03-14 16:42:12 +01:00
"id"
2022-11-29 10:02:40 +01:00
] ,
"additionalProperties" : false
2023-03-14 16:42:12 +01:00
} ,
2022-11-29 10:02:40 +01:00
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
2023-03-14 16:42:12 +01:00
"role" : {
2022-11-29 10:02:40 +01:00
"type" : "string" ,
"enum" : [
2023-03-14 16:42:12 +01:00
"Messages sequence ✨"
2022-11-29 10:02:40 +01:00
]
} ,
2023-03-14 16:42:12 +01:00
"content" : {
"type" : "object" ,
"properties" : {
"assistantMessagesVariableId" : {
"type" : "string"
2022-11-29 10:02:40 +01:00
} ,
2023-03-14 16:42:12 +01:00
"userMessagesVariableId" : {
"type" : "string"
2022-11-29 10:02:40 +01:00
}
2023-03-14 16:42:12 +01:00
} ,
"additionalProperties" : false
2022-11-29 10:02:40 +01:00
}
} ,
"required" : [
2023-03-14 16:42:12 +01:00
"id" ,
"role"
2022-11-29 10:02:40 +01:00
] ,
"additionalProperties" : false
}
]
}
2023-03-14 16:42:12 +01:00
} ,
2023-03-21 13:58:05 +01:00
"advancedSettings" : {
"type" : "object" ,
"properties" : {
"temperature" : {
"anyOf" : [
{
"type" : "number"
} ,
{ }
]
}
} ,
"additionalProperties" : false
} ,
2023-03-14 16:42:12 +01:00
"responseMapping" : {
"type" : "array" ,
"items" : {
2022-11-29 10:02:40 +01:00
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
2023-03-14 16:42:12 +01:00
"valueToExtract" : {
"type" : "string" ,
"enum" : [
"Message content" ,
"Total tokens"
]
2022-11-29 10:02:40 +01:00
} ,
2023-03-14 16:42:12 +01:00
"variableId" : {
2022-11-29 10:02:40 +01:00
"type" : "string"
}
} ,
"required" : [
"id" ,
2023-03-14 16:42:12 +01:00
"valueToExtract"
2022-11-29 10:02:40 +01:00
] ,
"additionalProperties" : false
2023-03-14 16:42:12 +01:00
}
} ,
"credentialsId" : {
"type" : "string"
}
} ,
"required" : [
"task" ,
"model" ,
"messages" ,
"responseMapping"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"task" : {
"type" : "string" ,
"enum" : [
"Create image"
]
} ,
"prompt" : {
"type" : "string"
} ,
"advancedOptions" : {
"type" : "object" ,
"properties" : {
"size" : {
"type" : "string" ,
"enum" : [
"256x256" ,
"512x512" ,
"1024x1024"
]
}
2022-11-29 10:02:40 +01:00
} ,
2023-03-14 16:42:12 +01:00
"additionalProperties" : false
} ,
"responseMapping" : {
"type" : "array" ,
"items" : {
2022-11-29 10:02:40 +01:00
"type" : "object" ,
"properties" : {
2023-03-14 16:42:12 +01:00
"id" : {
"type" : "string"
} ,
"valueToExtract" : {
2022-11-29 10:02:40 +01:00
"type" : "string" ,
"enum" : [
2023-03-14 16:42:12 +01:00
"Image URL"
2022-11-29 10:02:40 +01:00
]
} ,
2023-03-14 16:42:12 +01:00
"variableId" : {
"type" : "string"
2022-11-29 10:02:40 +01:00
}
} ,
"required" : [
2023-03-14 16:42:12 +01:00
"id" ,
"valueToExtract"
2022-11-29 10:02:40 +01:00
] ,
"additionalProperties" : false
}
2023-03-14 16:42:12 +01:00
} ,
"credentialsId" : {
"type" : "string"
}
} ,
"required" : [
"task" ,
"advancedOptions" ,
"responseMapping"
] ,
"additionalProperties" : false
}
]
}
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"options"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"Pabbly"
]
} ,
"options" : {
"type" : "object" ,
"properties" : {
"variablesForTest" : {
"type" : "array" ,
"items" : {
2022-11-29 10:02:40 +01:00
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
2023-03-14 16:42:12 +01:00
"variableId" : {
2022-11-29 10:02:40 +01:00
"type" : "string"
} ,
2023-03-14 16:42:12 +01:00
"value" : {
2022-11-29 10:02:40 +01:00
"type" : "string"
}
} ,
"required" : [
2023-03-14 16:42:12 +01:00
"id"
2022-11-29 10:02:40 +01:00
] ,
"additionalProperties" : false
2023-03-14 16:42:12 +01:00
}
} ,
"responseVariableMapping" : {
"type" : "array" ,
"items" : {
2022-11-29 10:02:40 +01:00
"type" : "object" ,
"properties" : {
2023-03-14 16:42:12 +01:00
"id" : {
"type" : "string"
2022-11-29 10:02:40 +01:00
} ,
2023-03-14 16:42:12 +01:00
"variableId" : {
"type" : "string"
} ,
"bodyPath" : {
"type" : "string"
2022-11-29 10:02:40 +01:00
}
} ,
"required" : [
2023-03-14 16:42:12 +01:00
"id"
2022-11-29 10:02:40 +01:00
] ,
"additionalProperties" : false
}
2023-03-14 16:42:12 +01:00
} ,
"isAdvancedConfig" : {
"type" : "boolean"
} ,
"isCustomBody" : {
"type" : "boolean"
}
} ,
"required" : [
"variablesForTest" ,
"responseVariableMapping"
] ,
"additionalProperties" : false
} ,
"webhookId" : {
"type" : "string"
}
2022-11-29 10:02:40 +01:00
} ,
2023-03-14 16:42:12 +01:00
"required" : [
"id" ,
"groupId" ,
"type" ,
"options" ,
"webhookId"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"Email"
]
} ,
"options" : {
"type" : "object" ,
"properties" : {
"credentialsId" : {
"type" : "string"
} ,
"isCustomBody" : {
"type" : "boolean"
} ,
"isBodyCode" : {
"type" : "boolean"
} ,
"recipients" : {
"type" : "array" ,
"items" : {
2022-11-29 10:02:40 +01:00
"type" : "string"
2023-03-14 16:42:12 +01:00
}
} ,
"subject" : {
"type" : "string"
} ,
"body" : {
"type" : "string"
} ,
"replyTo" : {
"type" : "string"
} ,
"cc" : {
"type" : "array" ,
"items" : {
2022-11-29 10:02:40 +01:00
"type" : "string"
2023-03-14 16:42:12 +01:00
}
} ,
"bcc" : {
"type" : "array" ,
"items" : {
2022-11-29 10:02:40 +01:00
"type" : "string"
}
} ,
2023-03-14 16:42:12 +01:00
"attachmentsVariableId" : {
"type" : "string"
}
2022-11-29 10:02:40 +01:00
} ,
2023-03-14 16:42:12 +01:00
"required" : [
"credentialsId" ,
"recipients"
] ,
"additionalProperties" : false
}
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"options"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"Webhook"
]
} ,
"options" : {
"type" : "object" ,
"properties" : {
"variablesForTest" : {
"type" : "array" ,
"items" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"variableId" : {
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"id"
] ,
"additionalProperties" : false
}
} ,
"responseVariableMapping" : {
"type" : "array" ,
"items" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
2022-11-29 10:02:40 +01:00
} ,
2023-03-14 16:42:12 +01:00
"variableId" : {
"type" : "string"
} ,
"bodyPath" : {
"type" : "string"
2022-11-29 10:02:40 +01:00
}
2023-03-14 16:42:12 +01:00
} ,
"required" : [
"id"
] ,
"additionalProperties" : false
2022-11-29 10:02:40 +01:00
}
} ,
2023-03-14 16:42:12 +01:00
"isAdvancedConfig" : {
"type" : "boolean"
} ,
"isCustomBody" : {
"type" : "boolean"
}
2022-11-29 10:02:40 +01:00
} ,
2023-03-14 16:42:12 +01:00
"required" : [
"variablesForTest" ,
"responseVariableMapping"
] ,
"additionalProperties" : false
2022-11-29 10:02:40 +01:00
} ,
2023-03-14 16:42:12 +01:00
"webhookId" : {
"type" : "string"
}
2022-11-29 10:02:40 +01:00
} ,
2023-03-14 16:42:12 +01:00
"required" : [
"id" ,
"groupId" ,
"type" ,
"options" ,
"webhookId"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"Zapier"
]
} ,
"options" : {
"type" : "object" ,
"properties" : {
"variablesForTest" : {
"type" : "array" ,
"items" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
2022-11-29 10:02:40 +01:00
} ,
2023-03-14 16:42:12 +01:00
"variableId" : {
"type" : "string"
} ,
"value" : {
"type" : "string"
2022-11-29 10:02:40 +01:00
}
2023-03-14 16:42:12 +01:00
} ,
"required" : [
"id"
] ,
"additionalProperties" : false
}
} ,
"responseVariableMapping" : {
"type" : "array" ,
"items" : {
2022-11-29 10:02:40 +01:00
"type" : "object" ,
"properties" : {
2023-03-14 16:42:12 +01:00
"id" : {
2022-11-29 10:02:40 +01:00
"type" : "string"
} ,
2023-03-14 16:42:12 +01:00
"variableId" : {
"type" : "string"
} ,
"bodyPath" : {
2022-11-29 10:02:40 +01:00
"type" : "string"
}
} ,
"required" : [
2023-03-14 16:42:12 +01:00
"id"
2022-11-29 10:02:40 +01:00
] ,
"additionalProperties" : false
}
2023-03-14 16:42:12 +01:00
} ,
"isAdvancedConfig" : {
"type" : "boolean"
} ,
"isCustomBody" : {
"type" : "boolean"
}
} ,
"required" : [
"variablesForTest" ,
"responseVariableMapping"
] ,
"additionalProperties" : false
2022-11-29 10:02:40 +01:00
} ,
2023-03-14 16:42:12 +01:00
"webhookId" : {
"type" : "string"
}
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"options" ,
"webhookId"
] ,
"additionalProperties" : false
}
]
}
]
}
}
} ,
"required" : [
"id" ,
"title" ,
"graphCoordinates" ,
"blocks"
] ,
"additionalProperties" : false
}
} ,
"edges" : {
"type" : "array" ,
"items" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"from" : {
"type" : "object" ,
"properties" : {
"groupId" : {
"type" : "string"
} ,
"blockId" : {
"type" : "string"
} ,
"itemId" : {
"type" : "string"
}
} ,
"required" : [
"groupId" ,
"blockId"
] ,
"additionalProperties" : false
} ,
"to" : {
"type" : "object" ,
"properties" : {
"groupId" : {
"type" : "string"
} ,
"blockId" : {
"type" : "string"
}
} ,
"required" : [
"groupId"
] ,
"additionalProperties" : false
}
} ,
"required" : [
"id" ,
"from" ,
"to"
] ,
"additionalProperties" : false
}
} ,
"variables" : {
"type" : "array" ,
"items" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"value" : {
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "array" ,
"items" : {
2023-03-21 15:42:03 +01:00
"type" : "string" ,
"nullable" : true
2023-03-14 16:42:12 +01:00
}
}
] ,
"nullable" : true
}
} ,
"required" : [
"id" ,
"name"
] ,
"additionalProperties" : false
}
} ,
"settings" : {
"type" : "object" ,
"properties" : {
"general" : {
"type" : "object" ,
"properties" : {
"isBrandingEnabled" : {
"type" : "boolean"
} ,
"isTypingEmulationEnabled" : {
"type" : "boolean"
} ,
"isInputPrefillEnabled" : {
"type" : "boolean"
} ,
"isHideQueryParamsEnabled" : {
"type" : "boolean"
} ,
"isNewResultOnRefreshEnabled" : {
"type" : "boolean"
}
} ,
"required" : [
"isBrandingEnabled"
] ,
"additionalProperties" : false
} ,
"typingEmulation" : {
"type" : "object" ,
"properties" : {
"enabled" : {
"type" : "boolean"
} ,
"speed" : {
"type" : "number"
} ,
"maxDelay" : {
"type" : "number"
}
} ,
"required" : [
"enabled" ,
"speed" ,
"maxDelay"
] ,
"additionalProperties" : false
} ,
"metadata" : {
"type" : "object" ,
"properties" : {
"title" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"imageUrl" : {
"type" : "string"
} ,
"favIconUrl" : {
"type" : "string"
} ,
"customHeadCode" : {
"type" : "string"
} ,
"googleTagManagerId" : {
"type" : "string"
}
} ,
"additionalProperties" : false
}
} ,
"required" : [
"general" ,
"typingEmulation" ,
"metadata"
] ,
"additionalProperties" : false
} ,
"theme" : {
"type" : "object" ,
"properties" : {
"general" : {
"type" : "object" ,
"properties" : {
"font" : {
"type" : "string"
} ,
"background" : {
"type" : "object" ,
"properties" : {
"type" : {
"type" : "string" ,
"enum" : [
"Color" ,
"Image" ,
"None"
]
} ,
"content" : {
"type" : "string"
}
} ,
"required" : [
"type"
] ,
"additionalProperties" : false
}
} ,
"required" : [
"font" ,
"background"
] ,
"additionalProperties" : false
} ,
"chat" : {
"type" : "object" ,
"properties" : {
"hostAvatar" : {
"type" : "object" ,
"properties" : {
"isEnabled" : {
"type" : "boolean"
} ,
"url" : {
"type" : "string"
}
} ,
"required" : [
"isEnabled"
] ,
"additionalProperties" : false
} ,
"guestAvatar" : {
"type" : "object" ,
"properties" : {
"isEnabled" : {
"type" : "boolean"
} ,
"url" : {
"type" : "string"
}
} ,
"required" : [
"isEnabled"
] ,
"additionalProperties" : false
} ,
"hostBubbles" : {
"type" : "object" ,
"properties" : {
"backgroundColor" : {
"type" : "string"
} ,
"color" : {
"type" : "string"
}
} ,
"required" : [
"backgroundColor" ,
"color"
] ,
"additionalProperties" : false
} ,
"guestBubbles" : {
"type" : "object" ,
"properties" : {
"backgroundColor" : {
"type" : "string"
} ,
"color" : {
"type" : "string"
}
} ,
"required" : [
"backgroundColor" ,
"color"
] ,
"additionalProperties" : false
} ,
"buttons" : {
"type" : "object" ,
"properties" : {
"backgroundColor" : {
"type" : "string"
} ,
"color" : {
"type" : "string"
}
} ,
"required" : [
"backgroundColor" ,
"color"
] ,
"additionalProperties" : false
} ,
"inputs" : {
"type" : "object" ,
"properties" : {
"backgroundColor" : {
"type" : "string"
} ,
"color" : {
"type" : "string"
} ,
"placeholderColor" : {
"type" : "string"
}
} ,
"required" : [
"backgroundColor" ,
"color" ,
"placeholderColor"
] ,
"additionalProperties" : false
2023-03-28 15:10:06 +02:00
} ,
"roundness" : {
"type" : "string" ,
"enum" : [
"none" ,
"medium" ,
"large"
]
2023-03-14 16:42:12 +01:00
}
} ,
"required" : [
"hostBubbles" ,
"guestBubbles" ,
"buttons" ,
"inputs"
] ,
"additionalProperties" : false
} ,
"customCss" : {
"type" : "string"
}
} ,
"required" : [
"general" ,
"chat"
] ,
"additionalProperties" : false
}
} ,
"required" : [
"id" ,
"groups" ,
"edges" ,
"variables" ,
"settings" ,
"theme"
] ,
"additionalProperties" : false
} ,
{
"type" : "string"
}
] ,
"description" : "Either a Typebot ID or a Typebot object. If you provide a Typebot object, it will be executed in preview mode. ([How can I find my typebot ID?](https://docs.typebot.io/api#how-to-find-my-typebotid))."
} ,
"isPreview" : {
"type" : "boolean" ,
"description" : "If set to `true`, it will start a Preview session with the unpublished bot and it won't be saved in the Results tab. You need to be authenticated for this to work."
} ,
"resultId" : {
"type" : "string" ,
"description" : "Provide it if you'd like to overwrite an existing result."
} ,
"startGroupId" : {
"type" : "string" ,
"description" : "Start chat from a specific group."
} ,
"prefilledVariables" : {
"type" : "object" ,
"additionalProperties" : { } ,
"description" : "[More info about prefilled variables.](https://docs.typebot.io/editor/variables#prefilled-variables)"
}
} ,
"required" : [
"typebot"
] ,
"additionalProperties" : false
}
} ,
"additionalProperties" : false
}
}
}
} ,
"parameters" : [ ] ,
"responses" : {
"200" : {
"description" : "Successful response" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"properties" : {
"messages" : {
"type" : "array" ,
"items" : {
"allOf" : [
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
}
} ,
"required" : [
"id"
] ,
"additionalProperties" : false
} ,
{
"anyOf" : [
{
"type" : "object" ,
"properties" : {
"type" : {
"type" : "string" ,
"enum" : [
"text"
]
} ,
"content" : {
"type" : "object" ,
"properties" : {
"html" : {
"type" : "string"
} ,
"plainText" : {
"type" : "string"
}
} ,
"required" : [
"html" ,
"plainText"
] ,
"additionalProperties" : false
}
} ,
"required" : [
"type" ,
"content"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"type" : {
"type" : "string" ,
"enum" : [
"image"
]
} ,
"content" : {
"type" : "object" ,
"properties" : {
"url" : {
"type" : "string"
}
} ,
"additionalProperties" : false
}
} ,
"required" : [
"type" ,
"content"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"type" : {
"type" : "string" ,
"enum" : [
"video"
]
} ,
"content" : {
"type" : "object" ,
"properties" : {
"url" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"url" ,
"youtube" ,
"vimeo"
]
}
} ,
"additionalProperties" : false
}
} ,
"required" : [
"type" ,
"content"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"type" : {
"type" : "string" ,
"enum" : [
"audio"
]
} ,
"content" : {
"type" : "object" ,
"properties" : {
"url" : {
"type" : "string"
}
} ,
"additionalProperties" : false
}
} ,
"required" : [
"type" ,
"content"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"type" : {
"type" : "string" ,
"enum" : [
"embed"
]
} ,
"content" : {
"type" : "object" ,
"properties" : {
"url" : {
"type" : "string"
} ,
"height" : {
"type" : "number"
}
} ,
"additionalProperties" : false
}
} ,
"required" : [
"type" ,
"content"
] ,
"additionalProperties" : false
}
]
}
]
}
} ,
"input" : {
"allOf" : [
{
"anyOf" : [
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"text input"
]
} ,
"options" : {
"type" : "object" ,
"properties" : {
"labels" : {
"type" : "object" ,
"properties" : {
"placeholder" : {
"type" : "string"
} ,
"button" : {
"type" : "string"
}
} ,
"required" : [
"placeholder" ,
"button"
] ,
"additionalProperties" : false
} ,
"variableId" : {
"type" : "string"
} ,
"isLong" : {
"type" : "boolean"
}
} ,
"required" : [
"labels" ,
"isLong"
] ,
"additionalProperties" : false
}
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"options"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"choice input"
]
} ,
"items" : {
"type" : "array" ,
"items" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"blockId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "number" ,
"enum" : [
0
]
} ,
"content" : {
"type" : "string"
}
} ,
"required" : [
"id" ,
"blockId" ,
"type"
] ,
"additionalProperties" : false
}
} ,
"options" : {
"type" : "object" ,
"properties" : {
"variableId" : {
"type" : "string"
} ,
"isMultipleChoice" : {
"type" : "boolean"
} ,
"buttonLabel" : {
"type" : "string"
} ,
"dynamicVariableId" : {
"type" : "string"
}
} ,
"required" : [
"isMultipleChoice" ,
"buttonLabel"
] ,
"additionalProperties" : false
}
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"items" ,
"options"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"email input"
]
} ,
"options" : {
"type" : "object" ,
"properties" : {
"variableId" : {
"type" : "string"
} ,
"labels" : {
"type" : "object" ,
"properties" : {
"placeholder" : {
"type" : "string"
2022-11-29 10:02:40 +01:00
} ,
2023-03-14 16:42:12 +01:00
"button" : {
"type" : "string"
2022-11-29 10:02:40 +01:00
}
2023-03-14 16:42:12 +01:00
} ,
"required" : [
"placeholder" ,
"button"
] ,
"additionalProperties" : false
2022-11-29 10:02:40 +01:00
} ,
2023-03-14 16:42:12 +01:00
"retryMessageContent" : {
"type" : "string"
}
} ,
"required" : [
"labels" ,
"retryMessageContent"
] ,
"additionalProperties" : false
}
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"options"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"number input"
]
} ,
"options" : {
"type" : "object" ,
"properties" : {
"variableId" : {
"type" : "string"
} ,
"labels" : {
"type" : "object" ,
"properties" : {
"placeholder" : {
"type" : "string"
2022-11-29 10:02:40 +01:00
} ,
2023-03-14 16:42:12 +01:00
"button" : {
"type" : "string"
2022-11-29 10:02:40 +01:00
}
2023-03-14 16:42:12 +01:00
} ,
"required" : [
"placeholder" ,
"button"
] ,
"additionalProperties" : false
} ,
"min" : {
"type" : "number"
} ,
"max" : {
"type" : "number"
} ,
"step" : {
"type" : "number"
}
} ,
"required" : [
"labels"
] ,
"additionalProperties" : false
}
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"options"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"url input"
]
} ,
"options" : {
"type" : "object" ,
"properties" : {
"variableId" : {
"type" : "string"
} ,
"labels" : {
"type" : "object" ,
"properties" : {
"placeholder" : {
"type" : "string"
} ,
"button" : {
"type" : "string"
}
} ,
"required" : [
"placeholder" ,
"button"
] ,
"additionalProperties" : false
} ,
"retryMessageContent" : {
"type" : "string"
}
} ,
"required" : [
"labels" ,
"retryMessageContent"
] ,
"additionalProperties" : false
}
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"options"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"phone number input"
]
} ,
"options" : {
"type" : "object" ,
"properties" : {
"variableId" : {
"type" : "string"
} ,
"labels" : {
"type" : "object" ,
"properties" : {
"placeholder" : {
"type" : "string"
} ,
"button" : {
"type" : "string"
}
} ,
"required" : [
"placeholder" ,
"button"
] ,
"additionalProperties" : false
} ,
"retryMessageContent" : {
"type" : "string"
} ,
"defaultCountryCode" : {
"type" : "string"
2022-11-29 10:02:40 +01:00
}
2023-03-14 16:42:12 +01:00
} ,
"required" : [
"labels" ,
"retryMessageContent"
] ,
"additionalProperties" : false
}
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"options"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"date input"
2022-11-29 10:02:40 +01:00
]
} ,
2023-03-14 16:42:12 +01:00
"options" : {
"type" : "object" ,
"properties" : {
"variableId" : {
"type" : "string"
} ,
"labels" : {
2022-11-29 10:02:40 +01:00
"type" : "object" ,
"properties" : {
2023-03-14 16:42:12 +01:00
"button" : {
2022-11-29 10:02:40 +01:00
"type" : "string"
} ,
2023-03-14 16:42:12 +01:00
"from" : {
2022-11-29 10:02:40 +01:00
"type" : "string"
} ,
2023-03-14 16:42:12 +01:00
"to" : {
2022-11-29 10:02:40 +01:00
"type" : "string"
}
} ,
"required" : [
2023-03-14 16:42:12 +01:00
"button" ,
"from" ,
"to"
2022-11-29 10:02:40 +01:00
] ,
"additionalProperties" : false
} ,
2023-03-14 16:42:12 +01:00
"hasTime" : {
"type" : "boolean"
} ,
"isRange" : {
"type" : "boolean"
}
} ,
"required" : [
"labels" ,
"hasTime" ,
"isRange"
] ,
"additionalProperties" : false
}
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"options"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"payment input"
]
} ,
"options" : {
"type" : "object" ,
"properties" : {
"variableId" : {
"type" : "string"
} ,
"provider" : {
"type" : "string" ,
"enum" : [
"Stripe"
]
} ,
"labels" : {
2022-11-29 10:02:40 +01:00
"type" : "object" ,
"properties" : {
2023-03-14 16:42:12 +01:00
"button" : {
"type" : "string"
2022-11-29 10:02:40 +01:00
} ,
2023-03-14 16:42:12 +01:00
"success" : {
"type" : "string"
2022-11-29 10:02:40 +01:00
}
} ,
"required" : [
2023-03-14 16:42:12 +01:00
"button"
2022-11-29 10:02:40 +01:00
] ,
"additionalProperties" : false
2023-03-14 16:42:12 +01:00
} ,
"additionalInformation" : {
"type" : "object" ,
"properties" : {
2023-03-29 16:33:06 +02:00
"description" : {
"type" : "string"
} ,
2023-03-14 16:42:12 +01:00
"name" : {
"type" : "string"
} ,
"email" : {
"type" : "string"
} ,
"phoneNumber" : {
"type" : "string"
}
} ,
"additionalProperties" : false
} ,
"credentialsId" : {
"type" : "string"
} ,
"currency" : {
"type" : "string"
} ,
"amount" : {
"type" : "string"
2022-11-29 10:02:40 +01:00
}
2023-03-14 16:42:12 +01:00
} ,
"required" : [
"provider" ,
"labels" ,
"currency"
] ,
"additionalProperties" : false
2022-11-29 10:02:40 +01:00
}
2023-03-14 16:42:12 +01:00
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"options"
] ,
"additionalProperties" : false
2022-11-29 10:02:40 +01:00
} ,
{
2023-03-14 16:42:12 +01:00
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"rating input"
]
} ,
"options" : {
2022-11-29 10:02:40 +01:00
"type" : "object" ,
"properties" : {
2023-03-14 16:42:12 +01:00
"variableId" : {
2022-11-29 10:02:40 +01:00
"type" : "string"
} ,
2023-03-14 16:42:12 +01:00
"buttonType" : {
"anyOf" : [
{
"type" : "string" ,
"enum" : [
"Icons"
]
} ,
{
"type" : "string" ,
"enum" : [
"Numbers"
]
}
]
2022-11-29 10:02:40 +01:00
} ,
2023-03-14 16:42:12 +01:00
"length" : {
"type" : "number"
} ,
"labels" : {
"type" : "object" ,
"properties" : {
"left" : {
"type" : "string"
} ,
"right" : {
"type" : "string"
} ,
"button" : {
"type" : "string"
}
} ,
"required" : [
"button"
] ,
"additionalProperties" : false
} ,
"customIcon" : {
"type" : "object" ,
"properties" : {
"isEnabled" : {
"type" : "boolean"
} ,
"svg" : {
"type" : "string"
}
} ,
"required" : [
"isEnabled"
] ,
"additionalProperties" : false
} ,
"isOneClickSubmitEnabled" : {
"type" : "boolean"
2022-11-29 10:02:40 +01:00
}
} ,
"required" : [
2023-03-14 16:42:12 +01:00
"buttonType" ,
"length" ,
"labels" ,
"customIcon"
2022-11-29 10:02:40 +01:00
] ,
"additionalProperties" : false
2023-03-14 16:42:12 +01:00
}
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"options"
] ,
"additionalProperties" : false
} ,
{
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"groupId" : {
"type" : "string"
} ,
"outgoingEdgeId" : {
"type" : "string"
} ,
"type" : {
"type" : "string" ,
"enum" : [
"file input"
]
2022-11-29 10:02:40 +01:00
} ,
2023-03-14 16:42:12 +01:00
"options" : {
2022-11-29 10:02:40 +01:00
"type" : "object" ,
"properties" : {
2023-03-14 16:42:12 +01:00
"variableId" : {
"type" : "string"
2022-11-29 10:02:40 +01:00
} ,
2023-03-14 16:42:12 +01:00
"isRequired" : {
"type" : "boolean"
} ,
"isMultipleAllowed" : {
"type" : "boolean"
} ,
"labels" : {
"type" : "object" ,
"properties" : {
"placeholder" : {
"type" : "string"
2022-11-29 10:02:40 +01:00
} ,
2023-03-14 16:42:12 +01:00
"button" : {
"type" : "string"
} ,
"clear" : {
"type" : "string"
} ,
"skip" : {
"type" : "string"
2022-11-29 10:02:40 +01:00
}
2023-03-14 16:42:12 +01:00
} ,
"required" : [
"placeholder" ,
"button"
] ,
"additionalProperties" : false
} ,
"sizeLimit" : {
"type" : "number"
2022-11-29 10:02:40 +01:00
}
} ,
"required" : [
2023-03-14 16:42:12 +01:00
"isMultipleAllowed" ,
"labels"
2022-11-29 10:02:40 +01:00
] ,
"additionalProperties" : false
}
2023-03-14 16:42:12 +01:00
} ,
"required" : [
"id" ,
"groupId" ,
"type" ,
"options"
] ,
"additionalProperties" : false
2022-11-29 10:02:40 +01:00
}
]
} ,
2022-12-22 17:02:34 +01:00
{
"type" : "object" ,
"properties" : {
"prefilledValue" : {
"type" : "string"
} ,
"runtimeOptions" : {
"type" : "object" ,
"properties" : {
"paymentIntentSecret" : {
"type" : "string"
} ,
"amountLabel" : {
"type" : "string"
} ,
"publicKey" : {
"type" : "string"
}
} ,
"required" : [
"paymentIntentSecret" ,
"amountLabel" ,
"publicKey"
] ,
"additionalProperties" : false
}
} ,
"additionalProperties" : false
}
]
} ,
2023-01-26 18:23:09 +01:00
"clientSideActions" : {
"type" : "array" ,
"items" : {
2023-01-27 10:54:59 +01:00
"allOf" : [
{
"type" : "object" ,
"properties" : {
"lastBubbleBlockId" : {
"type" : "string"
}
} ,
"additionalProperties" : false
} ,
2023-01-26 18:23:09 +01:00
{
"anyOf" : [
{
"anyOf" : [
{
2022-12-22 17:02:34 +01:00
"anyOf" : [
{
2023-01-27 10:54:59 +01:00
"anyOf" : [
{
2023-01-26 18:23:09 +01:00
"type" : "object" ,
"properties" : {
2023-01-27 15:58:05 +01:00
"scriptToExecute" : {
2023-01-27 10:54:59 +01:00
"type" : "object" ,
"properties" : {
"content" : {
"type" : "string"
} ,
"args" : {
"type" : "array" ,
"items" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
2023-01-26 18:23:09 +01:00
} ,
2023-01-27 10:54:59 +01:00
"value" : {
2023-01-26 18:23:09 +01:00
"anyOf" : [
{
"anyOf" : [
{
2023-02-23 14:44:37 +01:00
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "number"
}
]
2023-01-26 18:23:09 +01:00
} ,
{
2023-02-23 14:44:37 +01:00
"type" : "boolean"
2023-01-26 18:23:09 +01:00
}
]
2023-02-23 09:21:18 +01:00
} ,
{
2023-02-23 14:44:37 +01:00
"type" : "array" ,
"items" : {
2023-03-21 15:42:03 +01:00
"type" : "string" ,
"nullable" : true
2023-02-23 14:44:37 +01:00
}
2023-01-26 18:23:09 +01:00
}
2023-01-27 10:54:59 +01:00
] ,
"nullable" : true
2023-01-26 18:23:09 +01:00
}
2023-01-27 10:54:59 +01:00
} ,
"required" : [
"id"
2023-01-26 18:23:09 +01:00
] ,
2023-01-27 10:54:59 +01:00
"additionalProperties" : false
2023-01-26 18:23:09 +01:00
}
2023-01-27 10:54:59 +01:00
}
} ,
"required" : [
"content" ,
"args"
] ,
"additionalProperties" : false
2023-01-26 18:23:09 +01:00
}
} ,
"required" : [
2023-01-27 15:58:05 +01:00
"scriptToExecute"
2023-01-26 18:23:09 +01:00
] ,
"additionalProperties" : false
2023-01-27 10:54:59 +01:00
} ,
{
2023-01-26 18:23:09 +01:00
"type" : "object" ,
"properties" : {
2023-01-27 10:54:59 +01:00
"redirect" : {
"type" : "object" ,
"properties" : {
"url" : {
"type" : "string"
} ,
"isNewTab" : {
"type" : "boolean"
}
} ,
"required" : [
"isNewTab"
] ,
"additionalProperties" : false
2022-12-22 17:02:34 +01:00
}
2023-01-26 18:23:09 +01:00
} ,
"required" : [
2023-01-27 10:54:59 +01:00
"redirect"
2023-01-26 18:23:09 +01:00
] ,
"additionalProperties" : false
2022-12-22 17:02:34 +01:00
}
2023-01-27 10:54:59 +01:00
]
} ,
{
2023-01-26 18:23:09 +01:00
"type" : "object" ,
"properties" : {
2023-01-27 10:54:59 +01:00
"chatwoot" : {
2023-01-26 18:23:09 +01:00
"type" : "object" ,
"properties" : {
2023-01-27 15:58:05 +01:00
"scriptToExecute" : {
2023-01-27 10:54:59 +01:00
"type" : "object" ,
"properties" : {
"content" : {
"type" : "string"
} ,
"args" : {
"type" : "array" ,
"items" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
2023-01-26 18:23:09 +01:00
} ,
2023-01-27 10:54:59 +01:00
"value" : {
2023-01-26 18:23:09 +01:00
"anyOf" : [
{
"anyOf" : [
{
2023-02-23 14:44:37 +01:00
"anyOf" : [
{
"type" : "string"
} ,
{
"type" : "number"
}
]
2023-01-26 18:23:09 +01:00
} ,
{
2023-02-23 14:44:37 +01:00
"type" : "boolean"
2023-01-26 18:23:09 +01:00
}
]
2023-02-23 09:21:18 +01:00
} ,
{
2023-02-23 14:44:37 +01:00
"type" : "array" ,
"items" : {
2023-03-21 15:42:03 +01:00
"type" : "string" ,
"nullable" : true
2023-02-23 14:44:37 +01:00
}
2023-01-26 18:23:09 +01:00
}
2023-01-27 10:54:59 +01:00
] ,
"nullable" : true
2023-01-26 18:23:09 +01:00
}
2023-01-27 10:54:59 +01:00
} ,
"required" : [
"id"
2023-01-26 18:23:09 +01:00
] ,
2023-01-27 10:54:59 +01:00
"additionalProperties" : false
2023-01-26 18:23:09 +01:00
}
2023-01-27 10:54:59 +01:00
}
} ,
"required" : [
"content" ,
"args"
] ,
"additionalProperties" : false
2022-11-29 10:02:40 +01:00
}
2023-01-26 18:23:09 +01:00
} ,
"required" : [
2023-01-27 15:58:05 +01:00
"scriptToExecute"
2023-01-26 18:23:09 +01:00
] ,
"additionalProperties" : false
2022-11-29 10:02:40 +01:00
}
2023-01-26 18:23:09 +01:00
} ,
"required" : [
2023-01-27 10:54:59 +01:00
"chatwoot"
2022-11-29 10:02:40 +01:00
] ,
2023-01-26 18:23:09 +01:00
"additionalProperties" : false
2022-11-29 10:02:40 +01:00
}
2023-01-27 10:54:59 +01:00
]
} ,
{
"type" : "object" ,
"properties" : {
"googleAnalytics" : {
"type" : "object" ,
"properties" : {
"trackingId" : {
"type" : "string"
} ,
"category" : {
"type" : "string"
} ,
"action" : {
"type" : "string"
} ,
"label" : {
"type" : "string"
} ,
"value" : {
"type" : "number"
}
} ,
"additionalProperties" : false
}
2022-11-29 10:02:40 +01:00
} ,
"required" : [
2023-01-27 10:54:59 +01:00
"googleAnalytics"
2022-11-29 10:02:40 +01:00
] ,
"additionalProperties" : false
}
2023-01-26 18:23:09 +01:00
]
2022-11-29 10:02:40 +01:00
} ,
2023-01-26 18:23:09 +01:00
{
"type" : "object" ,
"properties" : {
2023-01-27 10:54:59 +01:00
"wait" : {
2023-01-26 18:23:09 +01:00
"type" : "object" ,
"properties" : {
2023-01-27 10:54:59 +01:00
"secondsToWaitFor" : {
2023-01-26 18:23:09 +01:00
"type" : "number"
}
} ,
2023-01-27 10:54:59 +01:00
"required" : [
"secondsToWaitFor"
] ,
2023-01-26 18:23:09 +01:00
"additionalProperties" : false
}
} ,
"required" : [
2023-01-27 10:54:59 +01:00
"wait"
2023-01-26 18:23:09 +01:00
] ,
"additionalProperties" : false
}
]
}
]
}
2022-12-22 17:02:34 +01:00
} ,
"sessionId" : {
"type" : "string"
} ,
"typebot" : {
"type" : "object" ,
"properties" : {
2023-01-16 12:13:21 +01:00
"id" : {
"type" : "string"
} ,
2022-12-22 17:02:34 +01:00
"theme" : {
2022-11-29 10:02:40 +01:00
"type" : "object" ,
"properties" : {
2022-12-22 17:02:34 +01:00
"general" : {
2022-11-29 10:02:40 +01:00
"type" : "object" ,
"properties" : {
2022-12-22 17:02:34 +01:00
"font" : {
"type" : "string"
} ,
"background" : {
2022-11-29 10:02:40 +01:00
"type" : "object" ,
"properties" : {
2022-12-22 17:02:34 +01:00
"type" : {
"type" : "string" ,
"enum" : [
"Color" ,
"Image" ,
"None"
]
} ,
2022-11-29 10:02:40 +01:00
"content" : {
"type" : "string"
}
} ,
"required" : [
2022-12-22 17:02:34 +01:00
"type"
2022-11-29 10:02:40 +01:00
] ,
"additionalProperties" : false
}
} ,
"required" : [
2022-12-22 17:02:34 +01:00
"font" ,
"background"
2022-11-29 10:02:40 +01:00
] ,
"additionalProperties" : false
} ,
2022-12-22 17:02:34 +01:00
"chat" : {
2022-11-29 10:02:40 +01:00
"type" : "object" ,
"properties" : {
2022-12-22 17:02:34 +01:00
"hostAvatar" : {
"type" : "object" ,
"properties" : {
"isEnabled" : {
"type" : "boolean"
} ,
"url" : {
"type" : "string"
}
} ,
"required" : [
"isEnabled"
] ,
"additionalProperties" : false
2022-11-29 10:02:40 +01:00
} ,
2022-12-22 17:02:34 +01:00
"guestAvatar" : {
"type" : "object" ,
"properties" : {
"isEnabled" : {
"type" : "boolean"
} ,
"url" : {
"type" : "string"
}
} ,
"required" : [
"isEnabled"
] ,
"additionalProperties" : false
2022-11-29 10:02:40 +01:00
} ,
2022-12-22 17:02:34 +01:00
"hostBubbles" : {
2022-11-29 10:02:40 +01:00
"type" : "object" ,
"properties" : {
2022-12-22 17:02:34 +01:00
"backgroundColor" : {
"type" : "string"
2022-11-29 10:02:40 +01:00
} ,
2022-12-22 17:02:34 +01:00
"color" : {
"type" : "string"
}
} ,
"required" : [
"backgroundColor" ,
"color"
] ,
"additionalProperties" : false
} ,
"guestBubbles" : {
"type" : "object" ,
"properties" : {
"backgroundColor" : {
"type" : "string"
2022-11-29 10:02:40 +01:00
} ,
2022-12-22 17:02:34 +01:00
"color" : {
2022-11-29 10:02:40 +01:00
"type" : "string"
}
} ,
"required" : [
2022-12-22 17:02:34 +01:00
"backgroundColor" ,
"color"
2022-11-29 10:02:40 +01:00
] ,
"additionalProperties" : false
} ,
2022-12-22 17:02:34 +01:00
"buttons" : {
2022-11-29 10:02:40 +01:00
"type" : "object" ,
"properties" : {
2022-12-22 17:02:34 +01:00
"backgroundColor" : {
"type" : "string"
2022-11-29 10:02:40 +01:00
} ,
2022-12-22 17:02:34 +01:00
"color" : {
"type" : "string"
}
} ,
"required" : [
"backgroundColor" ,
"color"
] ,
"additionalProperties" : false
} ,
"inputs" : {
2023-03-14 16:42:12 +01:00
"type" : "object" ,
"properties" : {
"backgroundColor" : {
"type" : "string"
2022-11-29 10:02:40 +01:00
} ,
2023-03-14 16:42:12 +01:00
"color" : {
"type" : "string"
} ,
"placeholderColor" : {
"type" : "string"
2022-11-29 10:02:40 +01:00
}
2023-03-14 16:42:12 +01:00
} ,
"required" : [
"backgroundColor" ,
"color" ,
"placeholderColor"
] ,
"additionalProperties" : false
2023-03-28 15:10:06 +02:00
} ,
"roundness" : {
"type" : "string" ,
"enum" : [
"none" ,
"medium" ,
"large"
]
2022-11-29 10:02:40 +01:00
}
} ,
"required" : [
2022-12-22 17:02:34 +01:00
"hostBubbles" ,
"guestBubbles" ,
"buttons" ,
"inputs"
2022-11-29 10:02:40 +01:00
] ,
"additionalProperties" : false
2022-12-22 17:02:34 +01:00
} ,
"customCss" : {
"type" : "string"
2022-11-29 10:02:40 +01:00
}
2022-12-22 17:02:34 +01:00
} ,
"required" : [
"general" ,
"chat"
2022-11-29 10:02:40 +01:00
] ,
2022-12-22 17:02:34 +01:00
"additionalProperties" : false
} ,
"settings" : {
"type" : "object" ,
"properties" : {
"general" : {
"type" : "object" ,
"properties" : {
"isBrandingEnabled" : {
"type" : "boolean"
} ,
"isTypingEmulationEnabled" : {
"type" : "boolean"
} ,
"isInputPrefillEnabled" : {
"type" : "boolean"
} ,
"isHideQueryParamsEnabled" : {
"type" : "boolean"
} ,
"isNewResultOnRefreshEnabled" : {
"type" : "boolean"
}
} ,
"required" : [
"isBrandingEnabled"
] ,
"additionalProperties" : false
} ,
"typingEmulation" : {
"type" : "object" ,
"properties" : {
"enabled" : {
"type" : "boolean"
} ,
"speed" : {
"type" : "number"
} ,
"maxDelay" : {
"type" : "number"
}
} ,
"required" : [
"enabled" ,
"speed" ,
"maxDelay"
] ,
"additionalProperties" : false
} ,
"metadata" : {
"type" : "object" ,
"properties" : {
"title" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"imageUrl" : {
"type" : "string"
} ,
"favIconUrl" : {
"type" : "string"
} ,
"customHeadCode" : {
"type" : "string"
} ,
"googleTagManagerId" : {
"type" : "string"
}
} ,
"additionalProperties" : false
}
} ,
"required" : [
"general" ,
"typingEmulation" ,
"metadata"
] ,
"additionalProperties" : false
2022-11-29 10:02:40 +01:00
}
} ,
2022-12-22 17:02:34 +01:00
"required" : [
2023-01-16 12:13:21 +01:00
"id" ,
2022-12-22 17:02:34 +01:00
"theme" ,
"settings"
] ,
2022-11-29 10:02:40 +01:00
"additionalProperties" : false
2022-12-22 17:02:34 +01:00
} ,
"resultId" : {
"type" : "string"
2023-01-16 12:13:21 +01:00
} ,
"dynamicTheme" : {
"type" : "object" ,
"properties" : {
"hostAvatarUrl" : {
"type" : "string"
} ,
"guestAvatarUrl" : {
"type" : "string"
}
} ,
"additionalProperties" : false
2023-01-25 11:27:47 +01:00
} ,
"logs" : {
"type" : "array" ,
"items" : {
2023-03-14 16:42:12 +01:00
"type" : "object" ,
"properties" : {
"status" : {
"type" : "string"
2023-01-25 11:27:47 +01:00
} ,
2023-03-14 16:42:12 +01:00
"description" : {
"type" : "string"
} ,
"details" : { }
} ,
"required" : [
"status" ,
"description"
] ,
"additionalProperties" : false
2023-01-25 11:27:47 +01:00
}
2022-11-29 10:02:40 +01:00
}
2022-12-22 17:02:34 +01:00
} ,
"required" : [
"messages"
] ,
"additionalProperties" : false
2022-11-29 10:02:40 +01:00
}
}
}
} ,
"default" : {
"$ref" : "#/components/responses/error"
}
}
}
2023-03-21 13:58:05 +01:00
} ,
"/typebots/{typebotId}/blocks/{blockId}/storage/upload-url" : {
"get" : {
"operationId" : "query.getUploadUrl" ,
"summary" : "Get upload URL for a file" ,
"description" : "Used for the web client to get the bucket upload file." ,
"parameters" : [
{
"name" : "typebotId" ,
"in" : "path" ,
"required" : true ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "blockId" ,
"in" : "path" ,
"required" : true ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "filePath" ,
"in" : "query" ,
"required" : true ,
"schema" : {
"type" : "string"
}
} ,
{
"name" : "fileType" ,
"in" : "query" ,
"required" : true ,
"schema" : {
"type" : "string"
}
}
] ,
"responses" : {
"200" : {
"description" : "Successful response" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"properties" : {
"presignedUrl" : {
"type" : "object" ,
"properties" : {
"url" : {
"type" : "string"
} ,
"fields" : { }
} ,
"required" : [
"url"
] ,
"additionalProperties" : false
} ,
"hasReachedStorageLimit" : {
"type" : "boolean"
}
} ,
"required" : [
"presignedUrl" ,
"hasReachedStorageLimit"
] ,
"additionalProperties" : false
}
}
}
} ,
"default" : {
"$ref" : "#/components/responses/error"
}
}
}
2022-11-29 10:02:40 +01:00
}
} ,
"components" : {
"securitySchemes" : {
"Authorization" : {
"type" : "http" ,
"scheme" : "bearer"
}
} ,
"responses" : {
"error" : {
"description" : "Error response" ,
"content" : {
"application/json" : {
"schema" : {
"type" : "object" ,
"properties" : {
"message" : {
"type" : "string"
} ,
"code" : {
"type" : "string"
} ,
"issues" : {
"type" : "array" ,
"items" : {
"type" : "object" ,
"properties" : {
"message" : {
"type" : "string"
}
} ,
"required" : [
"message"
] ,
"additionalProperties" : false
}
}
} ,
"required" : [
"message" ,
"code"
] ,
"additionalProperties" : false
}
}
}
}
}
} ,
"externalDocs" : {
"url" : "https://docs.typebot.io/api"
}
}
