{ "openapi": "3.0.3", "info": { "title": "Builder API", "version": "1.0.0" }, "servers": [ { "url": "https://app.typebot.io/api/v1" } ], "paths": { "/t/process": { "post": { "operationId": "processTelemetryEvent", "description": "Only used for the cloud version of Typebot. It's the way it processes telemetry events and inject it to thrid-party services.", "tags": [ "Telemetry" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "events": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "userId": { "type": "string" }, "workspaceId": { "type": "string" }, "name": { "type": "string", "enum": [ "Workspace created" ] }, "data": { "type": "object", "properties": { "name": { "type": "string" }, "plan": { "type": "string", "enum": [ "FREE", "STARTER", "PRO", "LIFETIME", "OFFERED", "CUSTOM", "UNLIMITED" ] } }, "required": [ "plan" ], "additionalProperties": false } }, "required": [ "userId", "workspaceId", "name", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string", "enum": [ "User created" ] }, "data": { "type": "object", "properties": { "email": { "type": "string" }, "name": { "type": "string" } }, "required": [ "email" ], "additionalProperties": false } }, "required": [ "userId", "name", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "userId": { "type": "string" }, "workspaceId": { "type": "string" }, "typebotId": { "type": "string" }, "name": { "type": "string", "enum": [ "Typebot created" ] }, "data": { "type": "object", "properties": { "name": { "type": "string" }, "template": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } }, "required": [ "userId", "workspaceId", "typebotId", "name", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "userId": { "type": "string" }, "workspaceId": { "type": "string" }, "typebotId": { "type": "string" }, "name": { "type": "string", "enum": [ "Typebot published" ] }, "data": { "type": "object", "properties": { "name": { "type": "string" }, "isFirstPublish": { "type": "boolean", "enum": [ true ] } }, "required": [ "name" ], "additionalProperties": false } }, "required": [ "userId", "workspaceId", "typebotId", "name", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "userId": { "type": "string" }, "workspaceId": { "type": "string" }, "name": { "type": "string", "enum": [ "Subscription updated" ] }, "data": { "type": "object", "properties": { "plan": { "type": "string", "enum": [ "FREE", "STARTER", "PRO", "LIFETIME", "OFFERED", "CUSTOM", "UNLIMITED" ] }, "additionalChatsIndex": { "type": "number" }, "additionalStorageIndex": { "type": "number" } }, "required": [ "plan", "additionalChatsIndex", "additionalStorageIndex" ], "additionalProperties": false } }, "required": [ "userId", "workspaceId", "name", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "userId": { "type": "string" }, "workspaceId": { "type": "string" }, "typebotId": { "type": "string" }, "name": { "type": "string", "enum": [ "New results collected" ] }, "data": { "type": "object", "properties": { "total": { "type": "number" }, "isFirstOfKind": { "type": "boolean", "enum": [ true ] } }, "required": [ "total" ], "additionalProperties": false } }, "required": [ "userId", "workspaceId", "typebotId", "name", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "userId": { "type": "string" }, "workspaceId": { "type": "string" }, "name": { "type": "string", "enum": [ "Workspace limit reached" ] }, "data": { "type": "object", "properties": { "chatsLimit": { "type": "number" }, "storageLimit": { "type": "number" }, "totalChatsUsed": { "type": "number" }, "totalStorageUsed": { "type": "number" } }, "required": [ "chatsLimit", "storageLimit", "totalChatsUsed", "totalStorageUsed" ], "additionalProperties": false } }, "required": [ "userId", "workspaceId", "name", "data" ], "additionalProperties": false }, { "type": "object", "properties": { "userId": { "type": "string" }, "workspaceId": { "type": "string" }, "name": { "type": "string", "enum": [ "Workspace automatically quarantined" ] }, "data": { "type": "object", "properties": { "chatsLimit": { "type": "number" }, "totalChatsUsed": { "type": "number" } }, "required": [ "chatsLimit", "totalChatsUsed" ], "additionalProperties": false } }, "required": [ "userId", "workspaceId", "name", "data" ], "additionalProperties": false } ] } } }, "required": [ "events" ], "additionalProperties": false } } } }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "Events injected" ] } }, "required": [ "message" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/typebots/{typebotId}/linkedTypebots": { "get": { "operationId": "getLinkedTypebots", "summary": "Get linked typebots", "tags": [ "Typebot" ], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "typebotId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "typebots": { "type": "array", "items": { "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": [ { "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 }, { "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": [ "richText" ], "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" }, "clickLink": { "type": "object", "properties": { "url": { "type": "string" }, "alt": { "type": "string" } }, "additionalProperties": false } }, "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" ] } }, "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" }, "height": { "anyOf": [ { "type": "number" }, {} ] } }, "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" ] }, "content": { "type": "object", "properties": { "url": { "type": "string" }, "isAutoplayEnabled": { "type": "boolean" } }, "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": [ "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", "description": "Deprecated" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "number", "enum": [ 0 ] }, "content": { "type": "string" }, "displayCondition": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "condition": { "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", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "logicalOperator", "comparisons" ], "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "id", "type" ], "additionalProperties": false } }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "isMultipleChoice": { "type": "boolean" }, "buttonLabel": { "type": "string" }, "dynamicVariableId": { "type": "string" }, "isSearchable": { "type": "boolean" }, "searchInputPlaceholder": { "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" }, "button": { "type": "string" } }, "required": [ "placeholder", "button" ], "additionalProperties": false }, "retryMessageContent": { "type": "string" } }, "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": [ "number input" ] }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "labels": { "type": "object", "properties": { "placeholder": { "type": "string" }, "button": { "type": "string" } }, "required": [ "placeholder", "button" ], "additionalProperties": false }, "min": { "anyOf": [ { "type": "number" }, {} ] }, "max": { "anyOf": [ { "type": "number" }, {} ] }, "step": { "anyOf": [ { "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" } }, "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" }, "format": { "type": "string" } }, "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": { "description": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "phoneNumber": { "type": "string" }, "address": { "type": "object", "properties": { "country": { "type": "string" }, "line1": { "type": "string" }, "line2": { "type": "string" }, "state": { "type": "string" }, "city": { "type": "string" }, "postalCode": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false }, "credentialsId": { "type": "string" }, "currency": { "type": "string" }, "amount": { "type": "string" }, "retryMessageContent": { "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 }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "picture choice input" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "blockId": { "type": "string", "description": "Deprecated" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "number", "enum": [ 3 ] }, "pictureSrc": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "displayCondition": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "condition": { "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", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "logicalOperator", "comparisons" ], "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "id", "type" ], "additionalProperties": false } }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "isMultipleChoice": { "type": "boolean" }, "isSearchable": { "type": "boolean" }, "buttonLabel": { "type": "string" }, "searchInputPlaceholder": { "type": "string" }, "dynamicItems": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "titlesVariableId": { "type": "string" }, "descriptionsVariableId": { "type": "string" }, "pictureSrcsVariableId": { "type": "string" } }, "additionalProperties": false } }, "required": [ "buttonLabel", "searchInputPlaceholder" ], "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": [ "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", "description": "Deprecated" }, "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", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "logicalOperator", "comparisons" ], "additionalProperties": false } }, "required": [ "id", "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" }, "type": { "type": "string", "enum": [ "Custom", "Empty", "User ID", "Now", "Today", "Yesterday", "Tomorrow", "Random ID", "Moment of the day", "Map item with same index", "Phone number", "Contact name" ] }, "mapListItemParams": { "type": "object", "properties": { "baseItemVariableId": { "type": "string" }, "baseListVariableId": { "type": "string" }, "targetListVariableId": { "type": "string" } }, "additionalProperties": false }, "isExecutedOnClient": { "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" }, "mergeResults": { "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": [ "Wait" ] }, "options": { "type": "object", "properties": { "secondsToWaitFor": { "type": "string" }, "shouldPause": { "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": [ "Jump" ] }, "options": { "type": "object", "properties": { "groupId": { "type": "string" }, "blockId": { "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": [ "AB test" ] }, "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": [ { "type": "object", "properties": { "id": { "type": "string" }, "blockId": { "type": "string", "description": "Deprecated" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "number", "enum": [ 2 ] }, "path": { "type": "string", "enum": [ "a" ] } }, "required": [ "id", "type", "path" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "blockId": { "type": "string", "description": "Deprecated" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "number", "enum": [ 2 ] }, "path": { "type": "string", "enum": [ "b" ] } }, "required": [ "id", "type", "path" ], "additionalProperties": false } ] }, "options": { "type": "object", "properties": { "aPercent": { "type": "number", "minimum": 0, "maximum": 100 } }, "required": [ "aPercent" ], "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": [ "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": { "anyOf": [ { "type": "number" }, {} ] }, "sendTo": { "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": [ "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, "description": "Deprecated. Use `filter` instead." }, "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", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "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 } }, "totalRowsToExtract": { "type": "string", "enum": [ "All", "First", "Last", "Random" ] } }, "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, "description": "Deprecated. Use `filter` instead." }, "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", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "logicalOperator": { "type": "string", "enum": [ "OR", "AND" ] } }, "required": [ "comparisons", "logicalOperator" ], "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 }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "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" }, "isExecutedOnClient": { "type": "boolean" }, "webhook": { "type": "object", "properties": { "id": { "type": "string" }, "queryParams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "headers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "method": { "type": "string", "enum": [ "POST", "GET", "PUT", "DELETE", "PATCH", "HEAD", "CONNECT", "OPTIONS", "TRACE" ] }, "url": { "type": "string" }, "body": { "type": "string" } }, "required": [ "id", "queryParams", "headers", "method" ], "additionalProperties": false } }, "required": [ "variablesForTest", "responseVariableMapping" ], "additionalProperties": false }, "webhookId": { "type": "string", "description": "Deprecated, use webhook.id instead" } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "OpenAI" ] }, "options": { "anyOf": [ { "type": "object", "properties": { "task": { "not": {} }, "credentialsId": { "type": "string" }, "baseUrl": { "type": "string", "default": "https://api.openai.com/v1" }, "apiVersion": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "properties": { "task": { "type": "string", "enum": [ "Create chat completion" ] }, "model": { "type": "string" }, "messages": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "role": { "type": "string", "enum": [ "system", "user", "assistant" ] }, "content": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "role": { "type": "string", "enum": [ "Messages sequence ✨" ] }, "content": { "type": "object", "properties": { "assistantMessagesVariableId": { "type": "string" }, "userMessagesVariableId": { "type": "string" } }, "additionalProperties": false } }, "required": [ "id", "role" ], "additionalProperties": false } ] } }, "advancedSettings": { "type": "object", "properties": { "temperature": { "anyOf": [ { "type": "number" }, {} ] } }, "additionalProperties": false }, "responseMapping": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "valueToExtract": { "type": "string", "enum": [ "Message content", "Total tokens" ] }, "variableId": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "credentialsId": { "type": "string" }, "baseUrl": { "type": "string", "default": "https://api.openai.com/v1" }, "apiVersion": { "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" ] } }, "additionalProperties": false }, "responseMapping": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "valueToExtract": { "type": "string", "enum": [ "Image URL" ] }, "variableId": { "type": "string" } }, "required": [ "id", "valueToExtract" ], "additionalProperties": false } }, "credentialsId": { "type": "string" }, "baseUrl": { "type": "string", "default": "https://api.openai.com/v1" }, "apiVersion": { "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": { "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" }, "isExecutedOnClient": { "type": "boolean" }, "webhook": { "type": "object", "properties": { "id": { "type": "string" }, "queryParams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "headers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "method": { "type": "string", "enum": [ "POST", "GET", "PUT", "DELETE", "PATCH", "HEAD", "CONNECT", "OPTIONS", "TRACE" ] }, "url": { "type": "string" }, "body": { "type": "string" } }, "required": [ "id", "queryParams", "headers", "method" ], "additionalProperties": false } }, "required": [ "variablesForTest", "responseVariableMapping" ], "additionalProperties": false }, "webhookId": { "type": "string", "description": "Deprecated, use webhook.id instead" } }, "required": [ "id", "groupId", "type", "options" ], "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": { "type": "string" } }, "subject": { "type": "string" }, "body": { "type": "string" }, "replyTo": { "type": "string" }, "cc": { "type": "array", "items": { "type": "string" } }, "bcc": { "type": "array", "items": { "type": "string" } }, "attachmentsVariableId": { "type": "string" } }, "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" }, "variableId": { "type": "string" }, "bodyPath": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "isAdvancedConfig": { "type": "boolean" }, "isCustomBody": { "type": "boolean" }, "isExecutedOnClient": { "type": "boolean" }, "webhook": { "type": "object", "properties": { "id": { "type": "string" }, "queryParams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "headers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "method": { "type": "string", "enum": [ "POST", "GET", "PUT", "DELETE", "PATCH", "HEAD", "CONNECT", "OPTIONS", "TRACE" ] }, "url": { "type": "string" }, "body": { "type": "string" } }, "required": [ "id", "queryParams", "headers", "method" ], "additionalProperties": false } }, "required": [ "variablesForTest", "responseVariableMapping" ], "additionalProperties": false }, "webhookId": { "type": "string", "description": "Deprecated, now integrated in webhook block options" } }, "required": [ "id", "groupId", "type", "options" ], "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" }, "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" }, "isExecutedOnClient": { "type": "boolean" }, "webhook": { "type": "object", "properties": { "id": { "type": "string" }, "queryParams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "headers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "method": { "type": "string", "enum": [ "POST", "GET", "PUT", "DELETE", "PATCH", "HEAD", "CONNECT", "OPTIONS", "TRACE" ] }, "url": { "type": "string" }, "body": { "type": "string" } }, "required": [ "id", "queryParams", "headers", "method" ], "additionalProperties": false } }, "required": [ "variablesForTest", "responseVariableMapping" ], "additionalProperties": false }, "webhookId": { "type": "string", "description": "Deprecated, use webhook.id instead" } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "Pixel" ] }, "options": { "anyOf": [ { "type": "object", "properties": { "pixelId": { "type": "string" }, "isInitSkip": { "type": "boolean" }, "params": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": {} }, "required": [ "id" ], "additionalProperties": false } }, "eventType": { "not": {} } }, "additionalProperties": false }, { "type": "object", "properties": { "pixelId": { "type": "string" }, "isInitSkip": { "type": "boolean" }, "params": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": {} }, "required": [ "id" ], "additionalProperties": false } }, "eventType": { "type": "string", "enum": [ "Lead", "Contact", "CompleteRegistration", "Schedule", "SubmitApplication", "ViewContent", "AddPaymentInfo", "AddToCart", "AddToWishlist", "CustomizeProduct", "Donate", "FindLocation", "InitiateCheckout", "Purchase", "Search", "StartTrial", "Subscribe" ] } }, "required": [ "eventType" ], "additionalProperties": false }, { "type": "object", "properties": { "pixelId": { "type": "string" }, "isInitSkip": { "type": "boolean" }, "params": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": {} }, "required": [ "id" ], "additionalProperties": false } }, "eventType": { "type": "string", "enum": [ "Custom" ] }, "name": { "type": "string" } }, "required": [ "eventType" ], "additionalProperties": false } ] } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false } ] } } }, "required": [ "id", "title", "graphCoordinates", "blocks" ], "additionalProperties": false } }, "variables": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string", "nullable": true } } ], "nullable": true } }, "required": [ "id", "name" ], "additionalProperties": false } }, "name": { "type": "string" } }, "required": [ "id", "groups", "variables", "name" ], "additionalProperties": false } } }, "required": [ "typebots" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/typebots/{typebotId}/analytics/totalAnswersInBlocks": { "get": { "operationId": "analytics-getTotalAnswersInBlocks", "summary": "List total answers in blocks", "tags": [ "Analytics" ], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "typebotId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "totalAnswersInBlocks": { "type": "array", "items": { "type": "object", "properties": { "blockId": { "type": "string" }, "itemId": { "type": "string" }, "total": { "type": "number" } }, "required": [ "blockId", "total" ], "additionalProperties": false } } }, "required": [ "totalAnswersInBlocks" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/workspaces": { "get": { "operationId": "workspace-listWorkspaces", "summary": "List workspaces", "tags": [ "Workspace" ], "security": [ { "Authorization": [] } ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "workspaces": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "icon": { "type": "string", "nullable": true }, "plan": { "type": "string", "enum": [ "FREE", "STARTER", "PRO", "LIFETIME", "OFFERED", "CUSTOM", "UNLIMITED" ] } }, "required": [ "id", "name", "icon", "plan" ], "additionalProperties": false } } }, "required": [ "workspaces" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } }, "post": { "operationId": "workspace-createWorkspace", "summary": "Create workspace", "tags": [ "Workspace" ], "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "icon": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } } } }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "workspace": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "icon": { "type": "string", "nullable": true }, "plan": { "type": "string", "enum": [ "FREE", "STARTER", "PRO", "LIFETIME", "OFFERED", "CUSTOM", "UNLIMITED" ] }, "stripeId": { "type": "string", "nullable": true }, "additionalChatsIndex": { "type": "number" }, "additionalStorageIndex": { "type": "number" }, "chatsLimitFirstEmailSentAt": { "type": "string", "format": "date-time", "nullable": true }, "chatsLimitSecondEmailSentAt": { "type": "string", "format": "date-time", "nullable": true }, "storageLimitFirstEmailSentAt": { "type": "string", "format": "date-time", "nullable": true }, "storageLimitSecondEmailSentAt": { "type": "string", "format": "date-time", "nullable": true }, "customChatsLimit": { "type": "number", "nullable": true }, "customStorageLimit": { "type": "number", "nullable": true }, "customSeatsLimit": { "type": "number", "nullable": true }, "isQuarantined": { "type": "boolean" }, "isSuspended": { "type": "boolean" } }, "required": [ "id", "createdAt", "updatedAt", "name", "icon", "plan", "stripeId", "additionalChatsIndex", "additionalStorageIndex", "chatsLimitFirstEmailSentAt", "chatsLimitSecondEmailSentAt", "storageLimitFirstEmailSentAt", "storageLimitSecondEmailSentAt", "customChatsLimit", "customStorageLimit", "customSeatsLimit", "isQuarantined", "isSuspended" ], "additionalProperties": false } }, "required": [ "workspace" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/workspaces/{workspaceId}": { "get": { "operationId": "workspace-getWorkspace", "summary": "Get workspace", "tags": [ "Workspace" ], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "workspace": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "icon": { "type": "string", "nullable": true }, "plan": { "type": "string", "enum": [ "FREE", "STARTER", "PRO", "LIFETIME", "OFFERED", "CUSTOM", "UNLIMITED" ] }, "stripeId": { "type": "string", "nullable": true }, "additionalChatsIndex": { "type": "number" }, "additionalStorageIndex": { "type": "number" }, "chatsLimitFirstEmailSentAt": { "type": "string", "format": "date-time", "nullable": true }, "chatsLimitSecondEmailSentAt": { "type": "string", "format": "date-time", "nullable": true }, "storageLimitFirstEmailSentAt": { "type": "string", "format": "date-time", "nullable": true }, "storageLimitSecondEmailSentAt": { "type": "string", "format": "date-time", "nullable": true }, "customChatsLimit": { "type": "number", "nullable": true }, "customStorageLimit": { "type": "number", "nullable": true }, "customSeatsLimit": { "type": "number", "nullable": true }, "isQuarantined": { "type": "boolean" }, "isSuspended": { "type": "boolean" } }, "required": [ "id", "createdAt", "updatedAt", "name", "icon", "plan", "stripeId", "additionalChatsIndex", "additionalStorageIndex", "chatsLimitFirstEmailSentAt", "chatsLimitSecondEmailSentAt", "storageLimitFirstEmailSentAt", "storageLimitSecondEmailSentAt", "customChatsLimit", "customStorageLimit", "customSeatsLimit", "isQuarantined", "isSuspended" ], "additionalProperties": false } }, "required": [ "workspace" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } }, "patch": { "operationId": "workspace-updateWorkspace", "summary": "Update workspace", "tags": [ "Workspace" ], "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "icon": { "type": "string" } }, "additionalProperties": false } } } }, "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "workspace": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "icon": { "type": "string", "nullable": true }, "plan": { "type": "string", "enum": [ "FREE", "STARTER", "PRO", "LIFETIME", "OFFERED", "CUSTOM", "UNLIMITED" ] }, "stripeId": { "type": "string", "nullable": true }, "additionalChatsIndex": { "type": "number" }, "additionalStorageIndex": { "type": "number" }, "chatsLimitFirstEmailSentAt": { "type": "string", "format": "date-time", "nullable": true }, "chatsLimitSecondEmailSentAt": { "type": "string", "format": "date-time", "nullable": true }, "storageLimitFirstEmailSentAt": { "type": "string", "format": "date-time", "nullable": true }, "storageLimitSecondEmailSentAt": { "type": "string", "format": "date-time", "nullable": true }, "customChatsLimit": { "type": "number", "nullable": true }, "customStorageLimit": { "type": "number", "nullable": true }, "customSeatsLimit": { "type": "number", "nullable": true }, "isQuarantined": { "type": "boolean" }, "isSuspended": { "type": "boolean" } }, "required": [ "id", "createdAt", "updatedAt", "name", "icon", "plan", "stripeId", "additionalChatsIndex", "additionalStorageIndex", "chatsLimitFirstEmailSentAt", "chatsLimitSecondEmailSentAt", "storageLimitFirstEmailSentAt", "storageLimitSecondEmailSentAt", "customChatsLimit", "customStorageLimit", "customSeatsLimit", "isQuarantined", "isSuspended" ], "additionalProperties": false } }, "required": [ "workspace" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } }, "delete": { "operationId": "workspace-deleteWorkspace", "summary": "Delete workspace", "tags": [ "Workspace" ], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/workspaces/{workspaceId}/members": { "get": { "operationId": "workspace-listMembersInWorkspace", "summary": "List members in workspace", "tags": [ "Workspace" ], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "members": { "type": "array", "items": { "type": "object", "properties": { "workspaceId": { "type": "string" }, "user": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "image": { "type": "string", "nullable": true } }, "required": [ "name", "email", "image" ], "additionalProperties": false }, "role": { "type": "string", "enum": [ "ADMIN", "MEMBER", "GUEST" ] } }, "required": [ "workspaceId", "user", "role" ], "additionalProperties": false } } }, "required": [ "members" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/typebots": { "post": { "operationId": "typebot-createTypebot", "summary": "Create a typebot", "tags": [ "Typebot" ], "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "workspaceId": { "type": "string" }, "typebot": { "type": "object", "properties": { "name": { "type": "string" }, "icon": { "type": "string", "nullable": true }, "selectedThemeTemplateId": { "type": "string", "nullable": true }, "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": [ { "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 }, { "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": [ "richText" ], "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" }, "clickLink": { "type": "object", "properties": { "url": { "type": "string" }, "alt": { "type": "string" } }, "additionalProperties": false } }, "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" ] } }, "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" }, "height": { "anyOf": [ { "type": "number" }, {} ] } }, "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" ] }, "content": { "type": "object", "properties": { "url": { "type": "string" }, "isAutoplayEnabled": { "type": "boolean" } }, "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": [ "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", "description": "Deprecated" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "number", "enum": [ 0 ] }, "content": { "type": "string" }, "displayCondition": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "condition": { "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", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "logicalOperator", "comparisons" ], "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "id", "type" ], "additionalProperties": false } }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "isMultipleChoice": { "type": "boolean" }, "buttonLabel": { "type": "string" }, "dynamicVariableId": { "type": "string" }, "isSearchable": { "type": "boolean" }, "searchInputPlaceholder": { "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" }, "button": { "type": "string" } }, "required": [ "placeholder", "button" ], "additionalProperties": false }, "retryMessageContent": { "type": "string" } }, "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": [ "number input" ] }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "labels": { "type": "object", "properties": { "placeholder": { "type": "string" }, "button": { "type": "string" } }, "required": [ "placeholder", "button" ], "additionalProperties": false }, "min": { "anyOf": [ { "type": "number" }, {} ] }, "max": { "anyOf": [ { "type": "number" }, {} ] }, "step": { "anyOf": [ { "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" } }, "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" }, "format": { "type": "string" } }, "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": { "description": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "phoneNumber": { "type": "string" }, "address": { "type": "object", "properties": { "country": { "type": "string" }, "line1": { "type": "string" }, "line2": { "type": "string" }, "state": { "type": "string" }, "city": { "type": "string" }, "postalCode": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false }, "credentialsId": { "type": "string" }, "currency": { "type": "string" }, "amount": { "type": "string" }, "retryMessageContent": { "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 }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "picture choice input" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "blockId": { "type": "string", "description": "Deprecated" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "number", "enum": [ 3 ] }, "pictureSrc": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "displayCondition": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "condition": { "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", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "logicalOperator", "comparisons" ], "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "id", "type" ], "additionalProperties": false } }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "isMultipleChoice": { "type": "boolean" }, "isSearchable": { "type": "boolean" }, "buttonLabel": { "type": "string" }, "searchInputPlaceholder": { "type": "string" }, "dynamicItems": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "titlesVariableId": { "type": "string" }, "descriptionsVariableId": { "type": "string" }, "pictureSrcsVariableId": { "type": "string" } }, "additionalProperties": false } }, "required": [ "buttonLabel", "searchInputPlaceholder" ], "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": [ "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", "description": "Deprecated" }, "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", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "logicalOperator", "comparisons" ], "additionalProperties": false } }, "required": [ "id", "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" }, "type": { "type": "string", "enum": [ "Custom", "Empty", "User ID", "Now", "Today", "Yesterday", "Tomorrow", "Random ID", "Moment of the day", "Map item with same index", "Phone number", "Contact name" ] }, "mapListItemParams": { "type": "object", "properties": { "baseItemVariableId": { "type": "string" }, "baseListVariableId": { "type": "string" }, "targetListVariableId": { "type": "string" } }, "additionalProperties": false }, "isExecutedOnClient": { "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" }, "mergeResults": { "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": [ "Wait" ] }, "options": { "type": "object", "properties": { "secondsToWaitFor": { "type": "string" }, "shouldPause": { "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": [ "Jump" ] }, "options": { "type": "object", "properties": { "groupId": { "type": "string" }, "blockId": { "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": [ "AB test" ] }, "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": [ { "type": "object", "properties": { "id": { "type": "string" }, "blockId": { "type": "string", "description": "Deprecated" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "number", "enum": [ 2 ] }, "path": { "type": "string", "enum": [ "a" ] } }, "required": [ "id", "type", "path" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "blockId": { "type": "string", "description": "Deprecated" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "number", "enum": [ 2 ] }, "path": { "type": "string", "enum": [ "b" ] } }, "required": [ "id", "type", "path" ], "additionalProperties": false } ] }, "options": { "type": "object", "properties": { "aPercent": { "type": "number", "minimum": 0, "maximum": 100 } }, "required": [ "aPercent" ], "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": [ "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": { "anyOf": [ { "type": "number" }, {} ] }, "sendTo": { "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": [ "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, "description": "Deprecated. Use `filter` instead." }, "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", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "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 } }, "totalRowsToExtract": { "type": "string", "enum": [ "All", "First", "Last", "Random" ] } }, "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, "description": "Deprecated. Use `filter` instead." }, "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", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "logicalOperator": { "type": "string", "enum": [ "OR", "AND" ] } }, "required": [ "comparisons", "logicalOperator" ], "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 }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "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" }, "isExecutedOnClient": { "type": "boolean" }, "webhook": { "type": "object", "properties": { "id": { "type": "string" }, "queryParams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "headers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "method": { "type": "string", "enum": [ "POST", "GET", "PUT", "DELETE", "PATCH", "HEAD", "CONNECT", "OPTIONS", "TRACE" ] }, "url": { "type": "string" }, "body": { "type": "string" } }, "required": [ "id", "queryParams", "headers", "method" ], "additionalProperties": false } }, "required": [ "variablesForTest", "responseVariableMapping" ], "additionalProperties": false }, "webhookId": { "type": "string", "description": "Deprecated, use webhook.id instead" } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "OpenAI" ] }, "options": { "anyOf": [ { "type": "object", "properties": { "task": { "not": {} }, "credentialsId": { "type": "string" }, "baseUrl": { "type": "string", "default": "https://api.openai.com/v1" }, "apiVersion": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "properties": { "task": { "type": "string", "enum": [ "Create chat completion" ] }, "model": { "type": "string" }, "messages": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "role": { "type": "string", "enum": [ "system", "user", "assistant" ] }, "content": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "role": { "type": "string", "enum": [ "Messages sequence ✨" ] }, "content": { "type": "object", "properties": { "assistantMessagesVariableId": { "type": "string" }, "userMessagesVariableId": { "type": "string" } }, "additionalProperties": false } }, "required": [ "id", "role" ], "additionalProperties": false } ] } }, "advancedSettings": { "type": "object", "properties": { "temperature": { "anyOf": [ { "type": "number" }, {} ] } }, "additionalProperties": false }, "responseMapping": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "valueToExtract": { "type": "string", "enum": [ "Message content", "Total tokens" ] }, "variableId": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "credentialsId": { "type": "string" }, "baseUrl": { "type": "string", "default": "https://api.openai.com/v1" }, "apiVersion": { "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" ] } }, "additionalProperties": false }, "responseMapping": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "valueToExtract": { "type": "string", "enum": [ "Image URL" ] }, "variableId": { "type": "string" } }, "required": [ "id", "valueToExtract" ], "additionalProperties": false } }, "credentialsId": { "type": "string" }, "baseUrl": { "type": "string", "default": "https://api.openai.com/v1" }, "apiVersion": { "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": { "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" }, "isExecutedOnClient": { "type": "boolean" }, "webhook": { "type": "object", "properties": { "id": { "type": "string" }, "queryParams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "headers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "method": { "type": "string", "enum": [ "POST", "GET", "PUT", "DELETE", "PATCH", "HEAD", "CONNECT", "OPTIONS", "TRACE" ] }, "url": { "type": "string" }, "body": { "type": "string" } }, "required": [ "id", "queryParams", "headers", "method" ], "additionalProperties": false } }, "required": [ "variablesForTest", "responseVariableMapping" ], "additionalProperties": false }, "webhookId": { "type": "string", "description": "Deprecated, use webhook.id instead" } }, "required": [ "id", "groupId", "type", "options" ], "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": { "type": "string" } }, "subject": { "type": "string" }, "body": { "type": "string" }, "replyTo": { "type": "string" }, "cc": { "type": "array", "items": { "type": "string" } }, "bcc": { "type": "array", "items": { "type": "string" } }, "attachmentsVariableId": { "type": "string" } }, "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" }, "variableId": { "type": "string" }, "bodyPath": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "isAdvancedConfig": { "type": "boolean" }, "isCustomBody": { "type": "boolean" }, "isExecutedOnClient": { "type": "boolean" }, "webhook": { "type": "object", "properties": { "id": { "type": "string" }, "queryParams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "headers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "method": { "type": "string", "enum": [ "POST", "GET", "PUT", "DELETE", "PATCH", "HEAD", "CONNECT", "OPTIONS", "TRACE" ] }, "url": { "type": "string" }, "body": { "type": "string" } }, "required": [ "id", "queryParams", "headers", "method" ], "additionalProperties": false } }, "required": [ "variablesForTest", "responseVariableMapping" ], "additionalProperties": false }, "webhookId": { "type": "string", "description": "Deprecated, now integrated in webhook block options" } }, "required": [ "id", "groupId", "type", "options" ], "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" }, "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" }, "isExecutedOnClient": { "type": "boolean" }, "webhook": { "type": "object", "properties": { "id": { "type": "string" }, "queryParams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "headers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "method": { "type": "string", "enum": [ "POST", "GET", "PUT", "DELETE", "PATCH", "HEAD", "CONNECT", "OPTIONS", "TRACE" ] }, "url": { "type": "string" }, "body": { "type": "string" } }, "required": [ "id", "queryParams", "headers", "method" ], "additionalProperties": false } }, "required": [ "variablesForTest", "responseVariableMapping" ], "additionalProperties": false }, "webhookId": { "type": "string", "description": "Deprecated, use webhook.id instead" } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "Pixel" ] }, "options": { "anyOf": [ { "type": "object", "properties": { "pixelId": { "type": "string" }, "isInitSkip": { "type": "boolean" }, "params": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": {} }, "required": [ "id" ], "additionalProperties": false } }, "eventType": { "not": {} } }, "additionalProperties": false }, { "type": "object", "properties": { "pixelId": { "type": "string" }, "isInitSkip": { "type": "boolean" }, "params": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": {} }, "required": [ "id" ], "additionalProperties": false } }, "eventType": { "type": "string", "enum": [ "Lead", "Contact", "CompleteRegistration", "Schedule", "SubmitApplication", "ViewContent", "AddPaymentInfo", "AddToCart", "AddToWishlist", "CustomizeProduct", "Donate", "FindLocation", "InitiateCheckout", "Purchase", "Search", "StartTrial", "Subscribe" ] } }, "required": [ "eventType" ], "additionalProperties": false }, { "type": "object", "properties": { "pixelId": { "type": "string" }, "isInitSkip": { "type": "boolean" }, "params": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": {} }, "required": [ "id" ], "additionalProperties": false } }, "eventType": { "type": "string", "enum": [ "Custom" ] }, "name": { "type": "string" } }, "required": [ "eventType" ], "additionalProperties": false } ] } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false } ] } } }, "required": [ "id", "title", "graphCoordinates", "blocks" ], "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 }, "roundness": { "type": "string", "enum": [ "none", "medium", "large" ] } }, "required": [ "hostBubbles", "guestBubbles", "buttons", "inputs" ], "additionalProperties": false }, "customCss": { "type": "string" } }, "required": [ "general", "chat" ], "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" }, "rememberUser": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "storage": { "type": "string", "enum": [ "session", "local" ] } }, "additionalProperties": false } }, "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 }, "whatsApp": { "type": "object", "properties": { "credentialsId": { "type": "string" }, "startCondition": { "type": "object", "properties": { "logicalOperator": { "type": "string", "enum": [ "OR", "AND" ] }, "comparisons": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "comparisonOperator": { "type": "string", "enum": [ "Equal to", "Not equal", "Contains", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "logicalOperator", "comparisons" ], "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "general", "typingEmulation", "metadata" ], "additionalProperties": false }, "folderId": { "type": "string", "nullable": true }, "variables": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string", "nullable": true } } ], "nullable": true } }, "required": [ "id", "name" ], "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 } }, "resultsTablePreferences": { "type": "object", "properties": { "columnsOrder": { "type": "array", "items": { "type": "string" } }, "columnsVisibility": { "type": "object", "additionalProperties": { "type": "boolean" } }, "columnsWidth": { "type": "object", "additionalProperties": { "type": "number" } } }, "required": [ "columnsOrder", "columnsVisibility", "columnsWidth" ], "additionalProperties": false, "nullable": true }, "publicId": { "type": "string", "nullable": true }, "customDomain": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "required": [ "workspaceId", "typebot" ], "additionalProperties": false } } } }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "typebot": { "type": "object", "properties": { "version": { "type": "string", "enum": [ "3", "4", "5" ], "nullable": true }, "id": { "type": "string" }, "name": { "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": [ { "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 }, { "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": [ "richText" ], "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" }, "clickLink": { "type": "object", "properties": { "url": { "type": "string" }, "alt": { "type": "string" } }, "additionalProperties": false } }, "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" ] } }, "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" }, "height": { "anyOf": [ { "type": "number" }, {} ] } }, "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" ] }, "content": { "type": "object", "properties": { "url": { "type": "string" }, "isAutoplayEnabled": { "type": "boolean" } }, "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": [ "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", "description": "Deprecated" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "number", "enum": [ 0 ] }, "content": { "type": "string" }, "displayCondition": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "condition": { "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", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "logicalOperator", "comparisons" ], "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "id", "type" ], "additionalProperties": false } }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "isMultipleChoice": { "type": "boolean" }, "buttonLabel": { "type": "string" }, "dynamicVariableId": { "type": "string" }, "isSearchable": { "type": "boolean" }, "searchInputPlaceholder": { "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" }, "button": { "type": "string" } }, "required": [ "placeholder", "button" ], "additionalProperties": false }, "retryMessageContent": { "type": "string" } }, "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": [ "number input" ] }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "labels": { "type": "object", "properties": { "placeholder": { "type": "string" }, "button": { "type": "string" } }, "required": [ "placeholder", "button" ], "additionalProperties": false }, "min": { "anyOf": [ { "type": "number" }, {} ] }, "max": { "anyOf": [ { "type": "number" }, {} ] }, "step": { "anyOf": [ { "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" } }, "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" }, "format": { "type": "string" } }, "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": { "description": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "phoneNumber": { "type": "string" }, "address": { "type": "object", "properties": { "country": { "type": "string" }, "line1": { "type": "string" }, "line2": { "type": "string" }, "state": { "type": "string" }, "city": { "type": "string" }, "postalCode": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false }, "credentialsId": { "type": "string" }, "currency": { "type": "string" }, "amount": { "type": "string" }, "retryMessageContent": { "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 }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "picture choice input" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "blockId": { "type": "string", "description": "Deprecated" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "number", "enum": [ 3 ] }, "pictureSrc": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "displayCondition": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "condition": { "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", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "logicalOperator", "comparisons" ], "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "id", "type" ], "additionalProperties": false } }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "isMultipleChoice": { "type": "boolean" }, "isSearchable": { "type": "boolean" }, "buttonLabel": { "type": "string" }, "searchInputPlaceholder": { "type": "string" }, "dynamicItems": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "titlesVariableId": { "type": "string" }, "descriptionsVariableId": { "type": "string" }, "pictureSrcsVariableId": { "type": "string" } }, "additionalProperties": false } }, "required": [ "buttonLabel", "searchInputPlaceholder" ], "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": [ "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", "description": "Deprecated" }, "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", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "logicalOperator", "comparisons" ], "additionalProperties": false } }, "required": [ "id", "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" }, "type": { "type": "string", "enum": [ "Custom", "Empty", "User ID", "Now", "Today", "Yesterday", "Tomorrow", "Random ID", "Moment of the day", "Map item with same index", "Phone number", "Contact name" ] }, "mapListItemParams": { "type": "object", "properties": { "baseItemVariableId": { "type": "string" }, "baseListVariableId": { "type": "string" }, "targetListVariableId": { "type": "string" } }, "additionalProperties": false }, "isExecutedOnClient": { "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" }, "mergeResults": { "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": [ "Wait" ] }, "options": { "type": "object", "properties": { "secondsToWaitFor": { "type": "string" }, "shouldPause": { "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": [ "Jump" ] }, "options": { "type": "object", "properties": { "groupId": { "type": "string" }, "blockId": { "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": [ "AB test" ] }, "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": [ { "type": "object", "properties": { "id": { "type": "string" }, "blockId": { "type": "string", "description": "Deprecated" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "number", "enum": [ 2 ] }, "path": { "type": "string", "enum": [ "a" ] } }, "required": [ "id", "type", "path" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "blockId": { "type": "string", "description": "Deprecated" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "number", "enum": [ 2 ] }, "path": { "type": "string", "enum": [ "b" ] } }, "required": [ "id", "type", "path" ], "additionalProperties": false } ] }, "options": { "type": "object", "properties": { "aPercent": { "type": "number", "minimum": 0, "maximum": 100 } }, "required": [ "aPercent" ], "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": [ "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": { "anyOf": [ { "type": "number" }, {} ] }, "sendTo": { "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": [ "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, "description": "Deprecated. Use `filter` instead." }, "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", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "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 } }, "totalRowsToExtract": { "type": "string", "enum": [ "All", "First", "Last", "Random" ] } }, "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, "description": "Deprecated. Use `filter` instead." }, "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", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "logicalOperator": { "type": "string", "enum": [ "OR", "AND" ] } }, "required": [ "comparisons", "logicalOperator" ], "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 }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "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" }, "isExecutedOnClient": { "type": "boolean" }, "webhook": { "type": "object", "properties": { "id": { "type": "string" }, "queryParams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "headers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "method": { "type": "string", "enum": [ "POST", "GET", "PUT", "DELETE", "PATCH", "HEAD", "CONNECT", "OPTIONS", "TRACE" ] }, "url": { "type": "string" }, "body": { "type": "string" } }, "required": [ "id", "queryParams", "headers", "method" ], "additionalProperties": false } }, "required": [ "variablesForTest", "responseVariableMapping" ], "additionalProperties": false }, "webhookId": { "type": "string", "description": "Deprecated, use webhook.id instead" } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "OpenAI" ] }, "options": { "anyOf": [ { "type": "object", "properties": { "task": { "not": {} }, "credentialsId": { "type": "string" }, "baseUrl": { "type": "string", "default": "https://api.openai.com/v1" }, "apiVersion": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "properties": { "task": { "type": "string", "enum": [ "Create chat completion" ] }, "model": { "type": "string" }, "messages": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "role": { "type": "string", "enum": [ "system", "user", "assistant" ] }, "content": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "role": { "type": "string", "enum": [ "Messages sequence ✨" ] }, "content": { "type": "object", "properties": { "assistantMessagesVariableId": { "type": "string" }, "userMessagesVariableId": { "type": "string" } }, "additionalProperties": false } }, "required": [ "id", "role" ], "additionalProperties": false } ] } }, "advancedSettings": { "type": "object", "properties": { "temperature": { "anyOf": [ { "type": "number" }, {} ] } }, "additionalProperties": false }, "responseMapping": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "valueToExtract": { "type": "string", "enum": [ "Message content", "Total tokens" ] }, "variableId": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "credentialsId": { "type": "string" }, "baseUrl": { "type": "string", "default": "https://api.openai.com/v1" }, "apiVersion": { "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" ] } }, "additionalProperties": false }, "responseMapping": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "valueToExtract": { "type": "string", "enum": [ "Image URL" ] }, "variableId": { "type": "string" } }, "required": [ "id", "valueToExtract" ], "additionalProperties": false } }, "credentialsId": { "type": "string" }, "baseUrl": { "type": "string", "default": "https://api.openai.com/v1" }, "apiVersion": { "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": { "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" }, "isExecutedOnClient": { "type": "boolean" }, "webhook": { "type": "object", "properties": { "id": { "type": "string" }, "queryParams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "headers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "method": { "type": "string", "enum": [ "POST", "GET", "PUT", "DELETE", "PATCH", "HEAD", "CONNECT", "OPTIONS", "TRACE" ] }, "url": { "type": "string" }, "body": { "type": "string" } }, "required": [ "id", "queryParams", "headers", "method" ], "additionalProperties": false } }, "required": [ "variablesForTest", "responseVariableMapping" ], "additionalProperties": false }, "webhookId": { "type": "string", "description": "Deprecated, use webhook.id instead" } }, "required": [ "id", "groupId", "type", "options" ], "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": { "type": "string" } }, "subject": { "type": "string" }, "body": { "type": "string" }, "replyTo": { "type": "string" }, "cc": { "type": "array", "items": { "type": "string" } }, "bcc": { "type": "array", "items": { "type": "string" } }, "attachmentsVariableId": { "type": "string" } }, "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" }, "variableId": { "type": "string" }, "bodyPath": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "isAdvancedConfig": { "type": "boolean" }, "isCustomBody": { "type": "boolean" }, "isExecutedOnClient": { "type": "boolean" }, "webhook": { "type": "object", "properties": { "id": { "type": "string" }, "queryParams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "headers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "method": { "type": "string", "enum": [ "POST", "GET", "PUT", "DELETE", "PATCH", "HEAD", "CONNECT", "OPTIONS", "TRACE" ] }, "url": { "type": "string" }, "body": { "type": "string" } }, "required": [ "id", "queryParams", "headers", "method" ], "additionalProperties": false } }, "required": [ "variablesForTest", "responseVariableMapping" ], "additionalProperties": false }, "webhookId": { "type": "string", "description": "Deprecated, now integrated in webhook block options" } }, "required": [ "id", "groupId", "type", "options" ], "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" }, "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" }, "isExecutedOnClient": { "type": "boolean" }, "webhook": { "type": "object", "properties": { "id": { "type": "string" }, "queryParams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "headers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "method": { "type": "string", "enum": [ "POST", "GET", "PUT", "DELETE", "PATCH", "HEAD", "CONNECT", "OPTIONS", "TRACE" ] }, "url": { "type": "string" }, "body": { "type": "string" } }, "required": [ "id", "queryParams", "headers", "method" ], "additionalProperties": false } }, "required": [ "variablesForTest", "responseVariableMapping" ], "additionalProperties": false }, "webhookId": { "type": "string", "description": "Deprecated, use webhook.id instead" } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "Pixel" ] }, "options": { "anyOf": [ { "type": "object", "properties": { "pixelId": { "type": "string" }, "isInitSkip": { "type": "boolean" }, "params": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": {} }, "required": [ "id" ], "additionalProperties": false } }, "eventType": { "not": {} } }, "additionalProperties": false }, { "type": "object", "properties": { "pixelId": { "type": "string" }, "isInitSkip": { "type": "boolean" }, "params": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": {} }, "required": [ "id" ], "additionalProperties": false } }, "eventType": { "type": "string", "enum": [ "Lead", "Contact", "CompleteRegistration", "Schedule", "SubmitApplication", "ViewContent", "AddPaymentInfo", "AddToCart", "AddToWishlist", "CustomizeProduct", "Donate", "FindLocation", "InitiateCheckout", "Purchase", "Search", "StartTrial", "Subscribe" ] } }, "required": [ "eventType" ], "additionalProperties": false }, { "type": "object", "properties": { "pixelId": { "type": "string" }, "isInitSkip": { "type": "boolean" }, "params": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": {} }, "required": [ "id" ], "additionalProperties": false } }, "eventType": { "type": "string", "enum": [ "Custom" ] }, "name": { "type": "string" } }, "required": [ "eventType" ], "additionalProperties": false } ] } }, "required": [ "id", "groupId", "type", "options" ], "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": { "type": "string", "nullable": true } } ], "nullable": true } }, "required": [ "id", "name" ], "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 }, "roundness": { "type": "string", "enum": [ "none", "medium", "large" ] } }, "required": [ "hostBubbles", "guestBubbles", "buttons", "inputs" ], "additionalProperties": false }, "customCss": { "type": "string" } }, "required": [ "general", "chat" ], "additionalProperties": false }, "selectedThemeTemplateId": { "type": "string", "nullable": true }, "settings": { "type": "object", "properties": { "general": { "type": "object", "properties": { "isBrandingEnabled": { "type": "boolean" }, "isTypingEmulationEnabled": { "type": "boolean" }, "isInputPrefillEnabled": { "type": "boolean" }, "isHideQueryParamsEnabled": { "type": "boolean" }, "isNewResultOnRefreshEnabled": { "type": "boolean" }, "rememberUser": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "storage": { "type": "string", "enum": [ "session", "local" ] } }, "additionalProperties": false } }, "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 }, "whatsApp": { "type": "object", "properties": { "credentialsId": { "type": "string" }, "startCondition": { "type": "object", "properties": { "logicalOperator": { "type": "string", "enum": [ "OR", "AND" ] }, "comparisons": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "comparisonOperator": { "type": "string", "enum": [ "Equal to", "Not equal", "Contains", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "logicalOperator", "comparisons" ], "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "general", "typingEmulation", "metadata" ], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "icon": { "type": "string", "nullable": true }, "folderId": { "type": "string", "nullable": true }, "publicId": { "type": "string", "nullable": true }, "customDomain": { "type": "string", "nullable": true }, "workspaceId": { "type": "string" }, "resultsTablePreferences": { "type": "object", "properties": { "columnsOrder": { "type": "array", "items": { "type": "string" } }, "columnsVisibility": { "type": "object", "additionalProperties": { "type": "boolean" } }, "columnsWidth": { "type": "object", "additionalProperties": { "type": "number" } } }, "required": [ "columnsOrder", "columnsVisibility", "columnsWidth" ], "additionalProperties": false, "nullable": true }, "isArchived": { "type": "boolean" }, "isClosed": { "type": "boolean" }, "whatsAppPhoneNumberId": { "type": "string", "nullable": true } }, "required": [ "version", "id", "name", "groups", "edges", "variables", "theme", "selectedThemeTemplateId", "settings", "createdAt", "updatedAt", "icon", "folderId", "publicId", "customDomain", "workspaceId", "resultsTablePreferences", "isArchived", "isClosed", "whatsAppPhoneNumberId" ], "additionalProperties": false } }, "required": [ "typebot" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } }, "get": { "operationId": "typebot-listTypebots", "summary": "List typebots", "tags": [ "Typebot" ], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "workspaceId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "folderId", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "typebots": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "icon": { "type": "string", "nullable": true }, "id": { "type": "string" }, "publishedTypebotId": { "type": "string" } }, "required": [ "name", "icon", "id" ], "additionalProperties": false } } }, "required": [ "typebots" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/typebots/{typebotId}": { "patch": { "operationId": "typebot-updateTypebot", "summary": "Update a typebot", "tags": [ "Typebot" ], "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "typebot": { "type": "object", "properties": { "name": { "type": "string" }, "icon": { "type": "string", "nullable": true }, "selectedThemeTemplateId": { "type": "string", "nullable": true }, "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": [ { "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 }, { "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": [ "richText" ], "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" }, "clickLink": { "type": "object", "properties": { "url": { "type": "string" }, "alt": { "type": "string" } }, "additionalProperties": false } }, "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" ] } }, "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" }, "height": { "anyOf": [ { "type": "number" }, {} ] } }, "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" ] }, "content": { "type": "object", "properties": { "url": { "type": "string" }, "isAutoplayEnabled": { "type": "boolean" } }, "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": [ "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", "description": "Deprecated" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "number", "enum": [ 0 ] }, "content": { "type": "string" }, "displayCondition": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "condition": { "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", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "logicalOperator", "comparisons" ], "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "id", "type" ], "additionalProperties": false } }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "isMultipleChoice": { "type": "boolean" }, "buttonLabel": { "type": "string" }, "dynamicVariableId": { "type": "string" }, "isSearchable": { "type": "boolean" }, "searchInputPlaceholder": { "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" }, "button": { "type": "string" } }, "required": [ "placeholder", "button" ], "additionalProperties": false }, "retryMessageContent": { "type": "string" } }, "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": [ "number input" ] }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "labels": { "type": "object", "properties": { "placeholder": { "type": "string" }, "button": { "type": "string" } }, "required": [ "placeholder", "button" ], "additionalProperties": false }, "min": { "anyOf": [ { "type": "number" }, {} ] }, "max": { "anyOf": [ { "type": "number" }, {} ] }, "step": { "anyOf": [ { "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" } }, "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" }, "format": { "type": "string" } }, "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": { "description": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "phoneNumber": { "type": "string" }, "address": { "type": "object", "properties": { "country": { "type": "string" }, "line1": { "type": "string" }, "line2": { "type": "string" }, "state": { "type": "string" }, "city": { "type": "string" }, "postalCode": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false }, "credentialsId": { "type": "string" }, "currency": { "type": "string" }, "amount": { "type": "string" }, "retryMessageContent": { "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 }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "picture choice input" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "blockId": { "type": "string", "description": "Deprecated" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "number", "enum": [ 3 ] }, "pictureSrc": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "displayCondition": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "condition": { "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", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "logicalOperator", "comparisons" ], "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "id", "type" ], "additionalProperties": false } }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "isMultipleChoice": { "type": "boolean" }, "isSearchable": { "type": "boolean" }, "buttonLabel": { "type": "string" }, "searchInputPlaceholder": { "type": "string" }, "dynamicItems": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "titlesVariableId": { "type": "string" }, "descriptionsVariableId": { "type": "string" }, "pictureSrcsVariableId": { "type": "string" } }, "additionalProperties": false } }, "required": [ "buttonLabel", "searchInputPlaceholder" ], "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": [ "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", "description": "Deprecated" }, "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", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "logicalOperator", "comparisons" ], "additionalProperties": false } }, "required": [ "id", "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" }, "type": { "type": "string", "enum": [ "Custom", "Empty", "User ID", "Now", "Today", "Yesterday", "Tomorrow", "Random ID", "Moment of the day", "Map item with same index", "Phone number", "Contact name" ] }, "mapListItemParams": { "type": "object", "properties": { "baseItemVariableId": { "type": "string" }, "baseListVariableId": { "type": "string" }, "targetListVariableId": { "type": "string" } }, "additionalProperties": false }, "isExecutedOnClient": { "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" }, "mergeResults": { "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": [ "Wait" ] }, "options": { "type": "object", "properties": { "secondsToWaitFor": { "type": "string" }, "shouldPause": { "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": [ "Jump" ] }, "options": { "type": "object", "properties": { "groupId": { "type": "string" }, "blockId": { "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": [ "AB test" ] }, "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": [ { "type": "object", "properties": { "id": { "type": "string" }, "blockId": { "type": "string", "description": "Deprecated" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "number", "enum": [ 2 ] }, "path": { "type": "string", "enum": [ "a" ] } }, "required": [ "id", "type", "path" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "blockId": { "type": "string", "description": "Deprecated" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "number", "enum": [ 2 ] }, "path": { "type": "string", "enum": [ "b" ] } }, "required": [ "id", "type", "path" ], "additionalProperties": false } ] }, "options": { "type": "object", "properties": { "aPercent": { "type": "number", "minimum": 0, "maximum": 100 } }, "required": [ "aPercent" ], "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": [ "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": { "anyOf": [ { "type": "number" }, {} ] }, "sendTo": { "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": [ "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, "description": "Deprecated. Use `filter` instead." }, "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", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "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 } }, "totalRowsToExtract": { "type": "string", "enum": [ "All", "First", "Last", "Random" ] } }, "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, "description": "Deprecated. Use `filter` instead." }, "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", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "logicalOperator": { "type": "string", "enum": [ "OR", "AND" ] } }, "required": [ "comparisons", "logicalOperator" ], "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 }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "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" }, "isExecutedOnClient": { "type": "boolean" }, "webhook": { "type": "object", "properties": { "id": { "type": "string" }, "queryParams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "headers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "method": { "type": "string", "enum": [ "POST", "GET", "PUT", "DELETE", "PATCH", "HEAD", "CONNECT", "OPTIONS", "TRACE" ] }, "url": { "type": "string" }, "body": { "type": "string" } }, "required": [ "id", "queryParams", "headers", "method" ], "additionalProperties": false } }, "required": [ "variablesForTest", "responseVariableMapping" ], "additionalProperties": false }, "webhookId": { "type": "string", "description": "Deprecated, use webhook.id instead" } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "OpenAI" ] }, "options": { "anyOf": [ { "type": "object", "properties": { "task": { "not": {} }, "credentialsId": { "type": "string" }, "baseUrl": { "type": "string", "default": "https://api.openai.com/v1" }, "apiVersion": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "properties": { "task": { "type": "string", "enum": [ "Create chat completion" ] }, "model": { "type": "string" }, "messages": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "role": { "type": "string", "enum": [ "system", "user", "assistant" ] }, "content": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "role": { "type": "string", "enum": [ "Messages sequence ✨" ] }, "content": { "type": "object", "properties": { "assistantMessagesVariableId": { "type": "string" }, "userMessagesVariableId": { "type": "string" } }, "additionalProperties": false } }, "required": [ "id", "role" ], "additionalProperties": false } ] } }, "advancedSettings": { "type": "object", "properties": { "temperature": { "anyOf": [ { "type": "number" }, {} ] } }, "additionalProperties": false }, "responseMapping": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "valueToExtract": { "type": "string", "enum": [ "Message content", "Total tokens" ] }, "variableId": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "credentialsId": { "type": "string" }, "baseUrl": { "type": "string", "default": "https://api.openai.com/v1" }, "apiVersion": { "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" ] } }, "additionalProperties": false }, "responseMapping": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "valueToExtract": { "type": "string", "enum": [ "Image URL" ] }, "variableId": { "type": "string" } }, "required": [ "id", "valueToExtract" ], "additionalProperties": false } }, "credentialsId": { "type": "string" }, "baseUrl": { "type": "string", "default": "https://api.openai.com/v1" }, "apiVersion": { "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": { "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" }, "isExecutedOnClient": { "type": "boolean" }, "webhook": { "type": "object", "properties": { "id": { "type": "string" }, "queryParams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "headers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "method": { "type": "string", "enum": [ "POST", "GET", "PUT", "DELETE", "PATCH", "HEAD", "CONNECT", "OPTIONS", "TRACE" ] }, "url": { "type": "string" }, "body": { "type": "string" } }, "required": [ "id", "queryParams", "headers", "method" ], "additionalProperties": false } }, "required": [ "variablesForTest", "responseVariableMapping" ], "additionalProperties": false }, "webhookId": { "type": "string", "description": "Deprecated, use webhook.id instead" } }, "required": [ "id", "groupId", "type", "options" ], "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": { "type": "string" } }, "subject": { "type": "string" }, "body": { "type": "string" }, "replyTo": { "type": "string" }, "cc": { "type": "array", "items": { "type": "string" } }, "bcc": { "type": "array", "items": { "type": "string" } }, "attachmentsVariableId": { "type": "string" } }, "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" }, "variableId": { "type": "string" }, "bodyPath": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "isAdvancedConfig": { "type": "boolean" }, "isCustomBody": { "type": "boolean" }, "isExecutedOnClient": { "type": "boolean" }, "webhook": { "type": "object", "properties": { "id": { "type": "string" }, "queryParams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "headers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "method": { "type": "string", "enum": [ "POST", "GET", "PUT", "DELETE", "PATCH", "HEAD", "CONNECT", "OPTIONS", "TRACE" ] }, "url": { "type": "string" }, "body": { "type": "string" } }, "required": [ "id", "queryParams", "headers", "method" ], "additionalProperties": false } }, "required": [ "variablesForTest", "responseVariableMapping" ], "additionalProperties": false }, "webhookId": { "type": "string", "description": "Deprecated, now integrated in webhook block options" } }, "required": [ "id", "groupId", "type", "options" ], "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" }, "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" }, "isExecutedOnClient": { "type": "boolean" }, "webhook": { "type": "object", "properties": { "id": { "type": "string" }, "queryParams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "headers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "method": { "type": "string", "enum": [ "POST", "GET", "PUT", "DELETE", "PATCH", "HEAD", "CONNECT", "OPTIONS", "TRACE" ] }, "url": { "type": "string" }, "body": { "type": "string" } }, "required": [ "id", "queryParams", "headers", "method" ], "additionalProperties": false } }, "required": [ "variablesForTest", "responseVariableMapping" ], "additionalProperties": false }, "webhookId": { "type": "string", "description": "Deprecated, use webhook.id instead" } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "Pixel" ] }, "options": { "anyOf": [ { "type": "object", "properties": { "pixelId": { "type": "string" }, "isInitSkip": { "type": "boolean" }, "params": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": {} }, "required": [ "id" ], "additionalProperties": false } }, "eventType": { "not": {} } }, "additionalProperties": false }, { "type": "object", "properties": { "pixelId": { "type": "string" }, "isInitSkip": { "type": "boolean" }, "params": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": {} }, "required": [ "id" ], "additionalProperties": false } }, "eventType": { "type": "string", "enum": [ "Lead", "Contact", "CompleteRegistration", "Schedule", "SubmitApplication", "ViewContent", "AddPaymentInfo", "AddToCart", "AddToWishlist", "CustomizeProduct", "Donate", "FindLocation", "InitiateCheckout", "Purchase", "Search", "StartTrial", "Subscribe" ] } }, "required": [ "eventType" ], "additionalProperties": false }, { "type": "object", "properties": { "pixelId": { "type": "string" }, "isInitSkip": { "type": "boolean" }, "params": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": {} }, "required": [ "id" ], "additionalProperties": false } }, "eventType": { "type": "string", "enum": [ "Custom" ] }, "name": { "type": "string" } }, "required": [ "eventType" ], "additionalProperties": false } ] } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false } ] } } }, "required": [ "id", "title", "graphCoordinates", "blocks" ], "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 }, "roundness": { "type": "string", "enum": [ "none", "medium", "large" ] } }, "required": [ "hostBubbles", "guestBubbles", "buttons", "inputs" ], "additionalProperties": false }, "customCss": { "type": "string" } }, "required": [ "general", "chat" ], "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" }, "rememberUser": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "storage": { "type": "string", "enum": [ "session", "local" ] } }, "additionalProperties": false } }, "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 }, "whatsApp": { "type": "object", "properties": { "credentialsId": { "type": "string" }, "startCondition": { "type": "object", "properties": { "logicalOperator": { "type": "string", "enum": [ "OR", "AND" ] }, "comparisons": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "comparisonOperator": { "type": "string", "enum": [ "Equal to", "Not equal", "Contains", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "logicalOperator", "comparisons" ], "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "general", "typingEmulation", "metadata" ], "additionalProperties": false }, "folderId": { "type": "string", "nullable": true }, "variables": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string", "nullable": true } } ], "nullable": true } }, "required": [ "id", "name" ], "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 } }, "resultsTablePreferences": { "type": "object", "properties": { "columnsOrder": { "type": "array", "items": { "type": "string" } }, "columnsVisibility": { "type": "object", "additionalProperties": { "type": "boolean" } }, "columnsWidth": { "type": "object", "additionalProperties": { "type": "number" } } }, "required": [ "columnsOrder", "columnsVisibility", "columnsWidth" ], "additionalProperties": false, "nullable": true }, "publicId": { "type": "string", "nullable": true }, "customDomain": { "type": "string", "nullable": true }, "isClosed": { "type": "boolean" }, "whatsAppPhoneNumberId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "updatedAt": { "type": "string", "format": "date-time", "description": "Used for checking if there is a newer version of the typebot in the database" } }, "required": [ "typebot" ], "additionalProperties": false } } } }, "parameters": [ { "name": "typebotId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "typebot": { "type": "object", "properties": { "version": { "type": "string", "enum": [ "3", "4", "5" ], "nullable": true }, "id": { "type": "string" }, "name": { "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": [ { "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 }, { "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": [ "richText" ], "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" }, "clickLink": { "type": "object", "properties": { "url": { "type": "string" }, "alt": { "type": "string" } }, "additionalProperties": false } }, "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" ] } }, "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" }, "height": { "anyOf": [ { "type": "number" }, {} ] } }, "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" ] }, "content": { "type": "object", "properties": { "url": { "type": "string" }, "isAutoplayEnabled": { "type": "boolean" } }, "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": [ "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", "description": "Deprecated" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "number", "enum": [ 0 ] }, "content": { "type": "string" }, "displayCondition": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "condition": { "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", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "logicalOperator", "comparisons" ], "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "id", "type" ], "additionalProperties": false } }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "isMultipleChoice": { "type": "boolean" }, "buttonLabel": { "type": "string" }, "dynamicVariableId": { "type": "string" }, "isSearchable": { "type": "boolean" }, "searchInputPlaceholder": { "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" }, "button": { "type": "string" } }, "required": [ "placeholder", "button" ], "additionalProperties": false }, "retryMessageContent": { "type": "string" } }, "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": [ "number input" ] }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "labels": { "type": "object", "properties": { "placeholder": { "type": "string" }, "button": { "type": "string" } }, "required": [ "placeholder", "button" ], "additionalProperties": false }, "min": { "anyOf": [ { "type": "number" }, {} ] }, "max": { "anyOf": [ { "type": "number" }, {} ] }, "step": { "anyOf": [ { "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" } }, "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" }, "format": { "type": "string" } }, "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": { "description": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "phoneNumber": { "type": "string" }, "address": { "type": "object", "properties": { "country": { "type": "string" }, "line1": { "type": "string" }, "line2": { "type": "string" }, "state": { "type": "string" }, "city": { "type": "string" }, "postalCode": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false }, "credentialsId": { "type": "string" }, "currency": { "type": "string" }, "amount": { "type": "string" }, "retryMessageContent": { "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 }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "picture choice input" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "blockId": { "type": "string", "description": "Deprecated" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "number", "enum": [ 3 ] }, "pictureSrc": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "displayCondition": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "condition": { "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", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "logicalOperator", "comparisons" ], "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "id", "type" ], "additionalProperties": false } }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "isMultipleChoice": { "type": "boolean" }, "isSearchable": { "type": "boolean" }, "buttonLabel": { "type": "string" }, "searchInputPlaceholder": { "type": "string" }, "dynamicItems": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "titlesVariableId": { "type": "string" }, "descriptionsVariableId": { "type": "string" }, "pictureSrcsVariableId": { "type": "string" } }, "additionalProperties": false } }, "required": [ "buttonLabel", "searchInputPlaceholder" ], "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": [ "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", "description": "Deprecated" }, "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", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "logicalOperator", "comparisons" ], "additionalProperties": false } }, "required": [ "id", "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" }, "type": { "type": "string", "enum": [ "Custom", "Empty", "User ID", "Now", "Today", "Yesterday", "Tomorrow", "Random ID", "Moment of the day", "Map item with same index", "Phone number", "Contact name" ] }, "mapListItemParams": { "type": "object", "properties": { "baseItemVariableId": { "type": "string" }, "baseListVariableId": { "type": "string" }, "targetListVariableId": { "type": "string" } }, "additionalProperties": false }, "isExecutedOnClient": { "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" }, "mergeResults": { "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": [ "Wait" ] }, "options": { "type": "object", "properties": { "secondsToWaitFor": { "type": "string" }, "shouldPause": { "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": [ "Jump" ] }, "options": { "type": "object", "properties": { "groupId": { "type": "string" }, "blockId": { "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": [ "AB test" ] }, "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": [ { "type": "object", "properties": { "id": { "type": "string" }, "blockId": { "type": "string", "description": "Deprecated" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "number", "enum": [ 2 ] }, "path": { "type": "string", "enum": [ "a" ] } }, "required": [ "id", "type", "path" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "blockId": { "type": "string", "description": "Deprecated" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "number", "enum": [ 2 ] }, "path": { "type": "string", "enum": [ "b" ] } }, "required": [ "id", "type", "path" ], "additionalProperties": false } ] }, "options": { "type": "object", "properties": { "aPercent": { "type": "number", "minimum": 0, "maximum": 100 } }, "required": [ "aPercent" ], "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": [ "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": { "anyOf": [ { "type": "number" }, {} ] }, "sendTo": { "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": [ "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, "description": "Deprecated. Use `filter` instead." }, "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", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "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 } }, "totalRowsToExtract": { "type": "string", "enum": [ "All", "First", "Last", "Random" ] } }, "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, "description": "Deprecated. Use `filter` instead." }, "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", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "logicalOperator": { "type": "string", "enum": [ "OR", "AND" ] } }, "required": [ "comparisons", "logicalOperator" ], "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 }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "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" }, "isExecutedOnClient": { "type": "boolean" }, "webhook": { "type": "object", "properties": { "id": { "type": "string" }, "queryParams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "headers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "method": { "type": "string", "enum": [ "POST", "GET", "PUT", "DELETE", "PATCH", "HEAD", "CONNECT", "OPTIONS", "TRACE" ] }, "url": { "type": "string" }, "body": { "type": "string" } }, "required": [ "id", "queryParams", "headers", "method" ], "additionalProperties": false } }, "required": [ "variablesForTest", "responseVariableMapping" ], "additionalProperties": false }, "webhookId": { "type": "string", "description": "Deprecated, use webhook.id instead" } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "OpenAI" ] }, "options": { "anyOf": [ { "type": "object", "properties": { "task": { "not": {} }, "credentialsId": { "type": "string" }, "baseUrl": { "type": "string", "default": "https://api.openai.com/v1" }, "apiVersion": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "properties": { "task": { "type": "string", "enum": [ "Create chat completion" ] }, "model": { "type": "string" }, "messages": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "role": { "type": "string", "enum": [ "system", "user", "assistant" ] }, "content": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "role": { "type": "string", "enum": [ "Messages sequence ✨" ] }, "content": { "type": "object", "properties": { "assistantMessagesVariableId": { "type": "string" }, "userMessagesVariableId": { "type": "string" } }, "additionalProperties": false } }, "required": [ "id", "role" ], "additionalProperties": false } ] } }, "advancedSettings": { "type": "object", "properties": { "temperature": { "anyOf": [ { "type": "number" }, {} ] } }, "additionalProperties": false }, "responseMapping": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "valueToExtract": { "type": "string", "enum": [ "Message content", "Total tokens" ] }, "variableId": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "credentialsId": { "type": "string" }, "baseUrl": { "type": "string", "default": "https://api.openai.com/v1" }, "apiVersion": { "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" ] } }, "additionalProperties": false }, "responseMapping": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "valueToExtract": { "type": "string", "enum": [ "Image URL" ] }, "variableId": { "type": "string" } }, "required": [ "id", "valueToExtract" ], "additionalProperties": false } }, "credentialsId": { "type": "string" }, "baseUrl": { "type": "string", "default": "https://api.openai.com/v1" }, "apiVersion": { "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": { "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" }, "isExecutedOnClient": { "type": "boolean" }, "webhook": { "type": "object", "properties": { "id": { "type": "string" }, "queryParams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "headers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "method": { "type": "string", "enum": [ "POST", "GET", "PUT", "DELETE", "PATCH", "HEAD", "CONNECT", "OPTIONS", "TRACE" ] }, "url": { "type": "string" }, "body": { "type": "string" } }, "required": [ "id", "queryParams", "headers", "method" ], "additionalProperties": false } }, "required": [ "variablesForTest", "responseVariableMapping" ], "additionalProperties": false }, "webhookId": { "type": "string", "description": "Deprecated, use webhook.id instead" } }, "required": [ "id", "groupId", "type", "options" ], "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": { "type": "string" } }, "subject": { "type": "string" }, "body": { "type": "string" }, "replyTo": { "type": "string" }, "cc": { "type": "array", "items": { "type": "string" } }, "bcc": { "type": "array", "items": { "type": "string" } }, "attachmentsVariableId": { "type": "string" } }, "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" }, "variableId": { "type": "string" }, "bodyPath": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "isAdvancedConfig": { "type": "boolean" }, "isCustomBody": { "type": "boolean" }, "isExecutedOnClient": { "type": "boolean" }, "webhook": { "type": "object", "properties": { "id": { "type": "string" }, "queryParams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "headers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "method": { "type": "string", "enum": [ "POST", "GET", "PUT", "DELETE", "PATCH", "HEAD", "CONNECT", "OPTIONS", "TRACE" ] }, "url": { "type": "string" }, "body": { "type": "string" } }, "required": [ "id", "queryParams", "headers", "method" ], "additionalProperties": false } }, "required": [ "variablesForTest", "responseVariableMapping" ], "additionalProperties": false }, "webhookId": { "type": "string", "description": "Deprecated, now integrated in webhook block options" } }, "required": [ "id", "groupId", "type", "options" ], "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" }, "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" }, "isExecutedOnClient": { "type": "boolean" }, "webhook": { "type": "object", "properties": { "id": { "type": "string" }, "queryParams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "headers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "method": { "type": "string", "enum": [ "POST", "GET", "PUT", "DELETE", "PATCH", "HEAD", "CONNECT", "OPTIONS", "TRACE" ] }, "url": { "type": "string" }, "body": { "type": "string" } }, "required": [ "id", "queryParams", "headers", "method" ], "additionalProperties": false } }, "required": [ "variablesForTest", "responseVariableMapping" ], "additionalProperties": false }, "webhookId": { "type": "string", "description": "Deprecated, use webhook.id instead" } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "Pixel" ] }, "options": { "anyOf": [ { "type": "object", "properties": { "pixelId": { "type": "string" }, "isInitSkip": { "type": "boolean" }, "params": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": {} }, "required": [ "id" ], "additionalProperties": false } }, "eventType": { "not": {} } }, "additionalProperties": false }, { "type": "object", "properties": { "pixelId": { "type": "string" }, "isInitSkip": { "type": "boolean" }, "params": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": {} }, "required": [ "id" ], "additionalProperties": false } }, "eventType": { "type": "string", "enum": [ "Lead", "Contact", "CompleteRegistration", "Schedule", "SubmitApplication", "ViewContent", "AddPaymentInfo", "AddToCart", "AddToWishlist", "CustomizeProduct", "Donate", "FindLocation", "InitiateCheckout", "Purchase", "Search", "StartTrial", "Subscribe" ] } }, "required": [ "eventType" ], "additionalProperties": false }, { "type": "object", "properties": { "pixelId": { "type": "string" }, "isInitSkip": { "type": "boolean" }, "params": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": {} }, "required": [ "id" ], "additionalProperties": false } }, "eventType": { "type": "string", "enum": [ "Custom" ] }, "name": { "type": "string" } }, "required": [ "eventType" ], "additionalProperties": false } ] } }, "required": [ "id", "groupId", "type", "options" ], "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": { "type": "string", "nullable": true } } ], "nullable": true } }, "required": [ "id", "name" ], "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 }, "roundness": { "type": "string", "enum": [ "none", "medium", "large" ] } }, "required": [ "hostBubbles", "guestBubbles", "buttons", "inputs" ], "additionalProperties": false }, "customCss": { "type": "string" } }, "required": [ "general", "chat" ], "additionalProperties": false }, "selectedThemeTemplateId": { "type": "string", "nullable": true }, "settings": { "type": "object", "properties": { "general": { "type": "object", "properties": { "isBrandingEnabled": { "type": "boolean" }, "isTypingEmulationEnabled": { "type": "boolean" }, "isInputPrefillEnabled": { "type": "boolean" }, "isHideQueryParamsEnabled": { "type": "boolean" }, "isNewResultOnRefreshEnabled": { "type": "boolean" }, "rememberUser": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "storage": { "type": "string", "enum": [ "session", "local" ] } }, "additionalProperties": false } }, "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 }, "whatsApp": { "type": "object", "properties": { "credentialsId": { "type": "string" }, "startCondition": { "type": "object", "properties": { "logicalOperator": { "type": "string", "enum": [ "OR", "AND" ] }, "comparisons": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "comparisonOperator": { "type": "string", "enum": [ "Equal to", "Not equal", "Contains", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "logicalOperator", "comparisons" ], "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "general", "typingEmulation", "metadata" ], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "icon": { "type": "string", "nullable": true }, "folderId": { "type": "string", "nullable": true }, "publicId": { "type": "string", "nullable": true }, "customDomain": { "type": "string", "nullable": true }, "workspaceId": { "type": "string" }, "resultsTablePreferences": { "type": "object", "properties": { "columnsOrder": { "type": "array", "items": { "type": "string" } }, "columnsVisibility": { "type": "object", "additionalProperties": { "type": "boolean" } }, "columnsWidth": { "type": "object", "additionalProperties": { "type": "number" } } }, "required": [ "columnsOrder", "columnsVisibility", "columnsWidth" ], "additionalProperties": false, "nullable": true }, "isArchived": { "type": "boolean" }, "isClosed": { "type": "boolean" }, "whatsAppPhoneNumberId": { "type": "string", "nullable": true } }, "required": [ "version", "id", "name", "groups", "edges", "variables", "theme", "selectedThemeTemplateId", "settings", "createdAt", "updatedAt", "icon", "folderId", "publicId", "customDomain", "workspaceId", "resultsTablePreferences", "isArchived", "isClosed", "whatsAppPhoneNumberId" ], "additionalProperties": false } }, "required": [ "typebot" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } }, "get": { "operationId": "typebot-getTypebot", "summary": "Get a typebot", "tags": [ "Typebot" ], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "typebotId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "typebot": { "type": "object", "properties": { "version": { "type": "string", "enum": [ "3", "4", "5" ], "nullable": true }, "id": { "type": "string" }, "name": { "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": [ { "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 }, { "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": [ "richText" ], "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" }, "clickLink": { "type": "object", "properties": { "url": { "type": "string" }, "alt": { "type": "string" } }, "additionalProperties": false } }, "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" ] } }, "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" }, "height": { "anyOf": [ { "type": "number" }, {} ] } }, "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" ] }, "content": { "type": "object", "properties": { "url": { "type": "string" }, "isAutoplayEnabled": { "type": "boolean" } }, "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": [ "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", "description": "Deprecated" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "number", "enum": [ 0 ] }, "content": { "type": "string" }, "displayCondition": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "condition": { "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", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "logicalOperator", "comparisons" ], "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "id", "type" ], "additionalProperties": false } }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "isMultipleChoice": { "type": "boolean" }, "buttonLabel": { "type": "string" }, "dynamicVariableId": { "type": "string" }, "isSearchable": { "type": "boolean" }, "searchInputPlaceholder": { "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" }, "button": { "type": "string" } }, "required": [ "placeholder", "button" ], "additionalProperties": false }, "retryMessageContent": { "type": "string" } }, "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": [ "number input" ] }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "labels": { "type": "object", "properties": { "placeholder": { "type": "string" }, "button": { "type": "string" } }, "required": [ "placeholder", "button" ], "additionalProperties": false }, "min": { "anyOf": [ { "type": "number" }, {} ] }, "max": { "anyOf": [ { "type": "number" }, {} ] }, "step": { "anyOf": [ { "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" } }, "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" }, "format": { "type": "string" } }, "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": { "description": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "phoneNumber": { "type": "string" }, "address": { "type": "object", "properties": { "country": { "type": "string" }, "line1": { "type": "string" }, "line2": { "type": "string" }, "state": { "type": "string" }, "city": { "type": "string" }, "postalCode": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false }, "credentialsId": { "type": "string" }, "currency": { "type": "string" }, "amount": { "type": "string" }, "retryMessageContent": { "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 }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "picture choice input" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "blockId": { "type": "string", "description": "Deprecated" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "number", "enum": [ 3 ] }, "pictureSrc": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "displayCondition": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "condition": { "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", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "logicalOperator", "comparisons" ], "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "id", "type" ], "additionalProperties": false } }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "isMultipleChoice": { "type": "boolean" }, "isSearchable": { "type": "boolean" }, "buttonLabel": { "type": "string" }, "searchInputPlaceholder": { "type": "string" }, "dynamicItems": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "titlesVariableId": { "type": "string" }, "descriptionsVariableId": { "type": "string" }, "pictureSrcsVariableId": { "type": "string" } }, "additionalProperties": false } }, "required": [ "buttonLabel", "searchInputPlaceholder" ], "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": [ "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", "description": "Deprecated" }, "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", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "logicalOperator", "comparisons" ], "additionalProperties": false } }, "required": [ "id", "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" }, "type": { "type": "string", "enum": [ "Custom", "Empty", "User ID", "Now", "Today", "Yesterday", "Tomorrow", "Random ID", "Moment of the day", "Map item with same index", "Phone number", "Contact name" ] }, "mapListItemParams": { "type": "object", "properties": { "baseItemVariableId": { "type": "string" }, "baseListVariableId": { "type": "string" }, "targetListVariableId": { "type": "string" } }, "additionalProperties": false }, "isExecutedOnClient": { "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" }, "mergeResults": { "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": [ "Wait" ] }, "options": { "type": "object", "properties": { "secondsToWaitFor": { "type": "string" }, "shouldPause": { "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": [ "Jump" ] }, "options": { "type": "object", "properties": { "groupId": { "type": "string" }, "blockId": { "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": [ "AB test" ] }, "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": [ { "type": "object", "properties": { "id": { "type": "string" }, "blockId": { "type": "string", "description": "Deprecated" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "number", "enum": [ 2 ] }, "path": { "type": "string", "enum": [ "a" ] } }, "required": [ "id", "type", "path" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "blockId": { "type": "string", "description": "Deprecated" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "number", "enum": [ 2 ] }, "path": { "type": "string", "enum": [ "b" ] } }, "required": [ "id", "type", "path" ], "additionalProperties": false } ] }, "options": { "type": "object", "properties": { "aPercent": { "type": "number", "minimum": 0, "maximum": 100 } }, "required": [ "aPercent" ], "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": [ "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": { "anyOf": [ { "type": "number" }, {} ] }, "sendTo": { "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": [ "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, "description": "Deprecated. Use `filter` instead." }, "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", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "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 } }, "totalRowsToExtract": { "type": "string", "enum": [ "All", "First", "Last", "Random" ] } }, "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, "description": "Deprecated. Use `filter` instead." }, "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", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "logicalOperator": { "type": "string", "enum": [ "OR", "AND" ] } }, "required": [ "comparisons", "logicalOperator" ], "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 }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "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" }, "isExecutedOnClient": { "type": "boolean" }, "webhook": { "type": "object", "properties": { "id": { "type": "string" }, "queryParams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "headers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "method": { "type": "string", "enum": [ "POST", "GET", "PUT", "DELETE", "PATCH", "HEAD", "CONNECT", "OPTIONS", "TRACE" ] }, "url": { "type": "string" }, "body": { "type": "string" } }, "required": [ "id", "queryParams", "headers", "method" ], "additionalProperties": false } }, "required": [ "variablesForTest", "responseVariableMapping" ], "additionalProperties": false }, "webhookId": { "type": "string", "description": "Deprecated, use webhook.id instead" } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "OpenAI" ] }, "options": { "anyOf": [ { "type": "object", "properties": { "task": { "not": {} }, "credentialsId": { "type": "string" }, "baseUrl": { "type": "string", "default": "https://api.openai.com/v1" }, "apiVersion": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "properties": { "task": { "type": "string", "enum": [ "Create chat completion" ] }, "model": { "type": "string" }, "messages": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "role": { "type": "string", "enum": [ "system", "user", "assistant" ] }, "content": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "role": { "type": "string", "enum": [ "Messages sequence ✨" ] }, "content": { "type": "object", "properties": { "assistantMessagesVariableId": { "type": "string" }, "userMessagesVariableId": { "type": "string" } }, "additionalProperties": false } }, "required": [ "id", "role" ], "additionalProperties": false } ] } }, "advancedSettings": { "type": "object", "properties": { "temperature": { "anyOf": [ { "type": "number" }, {} ] } }, "additionalProperties": false }, "responseMapping": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "valueToExtract": { "type": "string", "enum": [ "Message content", "Total tokens" ] }, "variableId": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "credentialsId": { "type": "string" }, "baseUrl": { "type": "string", "default": "https://api.openai.com/v1" }, "apiVersion": { "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" ] } }, "additionalProperties": false }, "responseMapping": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "valueToExtract": { "type": "string", "enum": [ "Image URL" ] }, "variableId": { "type": "string" } }, "required": [ "id", "valueToExtract" ], "additionalProperties": false } }, "credentialsId": { "type": "string" }, "baseUrl": { "type": "string", "default": "https://api.openai.com/v1" }, "apiVersion": { "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": { "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" }, "isExecutedOnClient": { "type": "boolean" }, "webhook": { "type": "object", "properties": { "id": { "type": "string" }, "queryParams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "headers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "method": { "type": "string", "enum": [ "POST", "GET", "PUT", "DELETE", "PATCH", "HEAD", "CONNECT", "OPTIONS", "TRACE" ] }, "url": { "type": "string" }, "body": { "type": "string" } }, "required": [ "id", "queryParams", "headers", "method" ], "additionalProperties": false } }, "required": [ "variablesForTest", "responseVariableMapping" ], "additionalProperties": false }, "webhookId": { "type": "string", "description": "Deprecated, use webhook.id instead" } }, "required": [ "id", "groupId", "type", "options" ], "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": { "type": "string" } }, "subject": { "type": "string" }, "body": { "type": "string" }, "replyTo": { "type": "string" }, "cc": { "type": "array", "items": { "type": "string" } }, "bcc": { "type": "array", "items": { "type": "string" } }, "attachmentsVariableId": { "type": "string" } }, "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" }, "variableId": { "type": "string" }, "bodyPath": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "isAdvancedConfig": { "type": "boolean" }, "isCustomBody": { "type": "boolean" }, "isExecutedOnClient": { "type": "boolean" }, "webhook": { "type": "object", "properties": { "id": { "type": "string" }, "queryParams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "headers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "method": { "type": "string", "enum": [ "POST", "GET", "PUT", "DELETE", "PATCH", "HEAD", "CONNECT", "OPTIONS", "TRACE" ] }, "url": { "type": "string" }, "body": { "type": "string" } }, "required": [ "id", "queryParams", "headers", "method" ], "additionalProperties": false } }, "required": [ "variablesForTest", "responseVariableMapping" ], "additionalProperties": false }, "webhookId": { "type": "string", "description": "Deprecated, now integrated in webhook block options" } }, "required": [ "id", "groupId", "type", "options" ], "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" }, "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" }, "isExecutedOnClient": { "type": "boolean" }, "webhook": { "type": "object", "properties": { "id": { "type": "string" }, "queryParams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "headers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "method": { "type": "string", "enum": [ "POST", "GET", "PUT", "DELETE", "PATCH", "HEAD", "CONNECT", "OPTIONS", "TRACE" ] }, "url": { "type": "string" }, "body": { "type": "string" } }, "required": [ "id", "queryParams", "headers", "method" ], "additionalProperties": false } }, "required": [ "variablesForTest", "responseVariableMapping" ], "additionalProperties": false }, "webhookId": { "type": "string", "description": "Deprecated, use webhook.id instead" } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "Pixel" ] }, "options": { "anyOf": [ { "type": "object", "properties": { "pixelId": { "type": "string" }, "isInitSkip": { "type": "boolean" }, "params": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": {} }, "required": [ "id" ], "additionalProperties": false } }, "eventType": { "not": {} } }, "additionalProperties": false }, { "type": "object", "properties": { "pixelId": { "type": "string" }, "isInitSkip": { "type": "boolean" }, "params": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": {} }, "required": [ "id" ], "additionalProperties": false } }, "eventType": { "type": "string", "enum": [ "Lead", "Contact", "CompleteRegistration", "Schedule", "SubmitApplication", "ViewContent", "AddPaymentInfo", "AddToCart", "AddToWishlist", "CustomizeProduct", "Donate", "FindLocation", "InitiateCheckout", "Purchase", "Search", "StartTrial", "Subscribe" ] } }, "required": [ "eventType" ], "additionalProperties": false }, { "type": "object", "properties": { "pixelId": { "type": "string" }, "isInitSkip": { "type": "boolean" }, "params": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": {} }, "required": [ "id" ], "additionalProperties": false } }, "eventType": { "type": "string", "enum": [ "Custom" ] }, "name": { "type": "string" } }, "required": [ "eventType" ], "additionalProperties": false } ] } }, "required": [ "id", "groupId", "type", "options" ], "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": { "type": "string", "nullable": true } } ], "nullable": true } }, "required": [ "id", "name" ], "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 }, "roundness": { "type": "string", "enum": [ "none", "medium", "large" ] } }, "required": [ "hostBubbles", "guestBubbles", "buttons", "inputs" ], "additionalProperties": false }, "customCss": { "type": "string" } }, "required": [ "general", "chat" ], "additionalProperties": false }, "selectedThemeTemplateId": { "type": "string", "nullable": true }, "settings": { "type": "object", "properties": { "general": { "type": "object", "properties": { "isBrandingEnabled": { "type": "boolean" }, "isTypingEmulationEnabled": { "type": "boolean" }, "isInputPrefillEnabled": { "type": "boolean" }, "isHideQueryParamsEnabled": { "type": "boolean" }, "isNewResultOnRefreshEnabled": { "type": "boolean" }, "rememberUser": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "storage": { "type": "string", "enum": [ "session", "local" ] } }, "additionalProperties": false } }, "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 }, "whatsApp": { "type": "object", "properties": { "credentialsId": { "type": "string" }, "startCondition": { "type": "object", "properties": { "logicalOperator": { "type": "string", "enum": [ "OR", "AND" ] }, "comparisons": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "comparisonOperator": { "type": "string", "enum": [ "Equal to", "Not equal", "Contains", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "logicalOperator", "comparisons" ], "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "general", "typingEmulation", "metadata" ], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "icon": { "type": "string", "nullable": true }, "folderId": { "type": "string", "nullable": true }, "publicId": { "type": "string", "nullable": true }, "customDomain": { "type": "string", "nullable": true }, "workspaceId": { "type": "string" }, "resultsTablePreferences": { "type": "object", "properties": { "columnsOrder": { "type": "array", "items": { "type": "string" } }, "columnsVisibility": { "type": "object", "additionalProperties": { "type": "boolean" } }, "columnsWidth": { "type": "object", "additionalProperties": { "type": "number" } } }, "required": [ "columnsOrder", "columnsVisibility", "columnsWidth" ], "additionalProperties": false, "nullable": true }, "isArchived": { "type": "boolean" }, "isClosed": { "type": "boolean" }, "whatsAppPhoneNumberId": { "type": "string", "nullable": true } }, "required": [ "version", "id", "name", "groups", "edges", "variables", "theme", "selectedThemeTemplateId", "settings", "createdAt", "updatedAt", "icon", "folderId", "publicId", "customDomain", "workspaceId", "resultsTablePreferences", "isArchived", "isClosed", "whatsAppPhoneNumberId" ], "additionalProperties": false }, "isReadOnly": { "type": "boolean" } }, "required": [ "typebot", "isReadOnly" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } }, "delete": { "operationId": "typebot-deleteTypebot", "summary": "Delete a typebot", "tags": [ "Typebot" ], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "typebotId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "success" ] } }, "required": [ "message" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/typebots/{typebotId}/publishedTypebot": { "get": { "operationId": "typebot-getPublishedTypebot", "summary": "Get published typebot", "tags": [ "Typebot" ], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "typebotId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "publishedTypebot": { "type": "object", "properties": { "id": { "type": "string" }, "version": { "type": "string", "enum": [ "3", "4", "5" ], "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "typebotId": { "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": [ { "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 }, { "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": [ "richText" ], "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" }, "clickLink": { "type": "object", "properties": { "url": { "type": "string" }, "alt": { "type": "string" } }, "additionalProperties": false } }, "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" ] } }, "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" }, "height": { "anyOf": [ { "type": "number" }, {} ] } }, "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" ] }, "content": { "type": "object", "properties": { "url": { "type": "string" }, "isAutoplayEnabled": { "type": "boolean" } }, "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": [ "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", "description": "Deprecated" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "number", "enum": [ 0 ] }, "content": { "type": "string" }, "displayCondition": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "condition": { "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", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "logicalOperator", "comparisons" ], "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "id", "type" ], "additionalProperties": false } }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "isMultipleChoice": { "type": "boolean" }, "buttonLabel": { "type": "string" }, "dynamicVariableId": { "type": "string" }, "isSearchable": { "type": "boolean" }, "searchInputPlaceholder": { "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" }, "button": { "type": "string" } }, "required": [ "placeholder", "button" ], "additionalProperties": false }, "retryMessageContent": { "type": "string" } }, "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": [ "number input" ] }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "labels": { "type": "object", "properties": { "placeholder": { "type": "string" }, "button": { "type": "string" } }, "required": [ "placeholder", "button" ], "additionalProperties": false }, "min": { "anyOf": [ { "type": "number" }, {} ] }, "max": { "anyOf": [ { "type": "number" }, {} ] }, "step": { "anyOf": [ { "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" } }, "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" }, "format": { "type": "string" } }, "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": { "description": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "phoneNumber": { "type": "string" }, "address": { "type": "object", "properties": { "country": { "type": "string" }, "line1": { "type": "string" }, "line2": { "type": "string" }, "state": { "type": "string" }, "city": { "type": "string" }, "postalCode": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false }, "credentialsId": { "type": "string" }, "currency": { "type": "string" }, "amount": { "type": "string" }, "retryMessageContent": { "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 }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "picture choice input" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "blockId": { "type": "string", "description": "Deprecated" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "number", "enum": [ 3 ] }, "pictureSrc": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "displayCondition": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "condition": { "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", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "logicalOperator", "comparisons" ], "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "id", "type" ], "additionalProperties": false } }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "isMultipleChoice": { "type": "boolean" }, "isSearchable": { "type": "boolean" }, "buttonLabel": { "type": "string" }, "searchInputPlaceholder": { "type": "string" }, "dynamicItems": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "titlesVariableId": { "type": "string" }, "descriptionsVariableId": { "type": "string" }, "pictureSrcsVariableId": { "type": "string" } }, "additionalProperties": false } }, "required": [ "buttonLabel", "searchInputPlaceholder" ], "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": [ "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", "description": "Deprecated" }, "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", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "logicalOperator", "comparisons" ], "additionalProperties": false } }, "required": [ "id", "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" }, "type": { "type": "string", "enum": [ "Custom", "Empty", "User ID", "Now", "Today", "Yesterday", "Tomorrow", "Random ID", "Moment of the day", "Map item with same index", "Phone number", "Contact name" ] }, "mapListItemParams": { "type": "object", "properties": { "baseItemVariableId": { "type": "string" }, "baseListVariableId": { "type": "string" }, "targetListVariableId": { "type": "string" } }, "additionalProperties": false }, "isExecutedOnClient": { "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" }, "mergeResults": { "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": [ "Wait" ] }, "options": { "type": "object", "properties": { "secondsToWaitFor": { "type": "string" }, "shouldPause": { "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": [ "Jump" ] }, "options": { "type": "object", "properties": { "groupId": { "type": "string" }, "blockId": { "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": [ "AB test" ] }, "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": [ { "type": "object", "properties": { "id": { "type": "string" }, "blockId": { "type": "string", "description": "Deprecated" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "number", "enum": [ 2 ] }, "path": { "type": "string", "enum": [ "a" ] } }, "required": [ "id", "type", "path" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "blockId": { "type": "string", "description": "Deprecated" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "number", "enum": [ 2 ] }, "path": { "type": "string", "enum": [ "b" ] } }, "required": [ "id", "type", "path" ], "additionalProperties": false } ] }, "options": { "type": "object", "properties": { "aPercent": { "type": "number", "minimum": 0, "maximum": 100 } }, "required": [ "aPercent" ], "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": [ "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": { "anyOf": [ { "type": "number" }, {} ] }, "sendTo": { "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": [ "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, "description": "Deprecated. Use `filter` instead." }, "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", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "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 } }, "totalRowsToExtract": { "type": "string", "enum": [ "All", "First", "Last", "Random" ] } }, "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, "description": "Deprecated. Use `filter` instead." }, "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", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "logicalOperator": { "type": "string", "enum": [ "OR", "AND" ] } }, "required": [ "comparisons", "logicalOperator" ], "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 }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "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" }, "isExecutedOnClient": { "type": "boolean" }, "webhook": { "type": "object", "properties": { "id": { "type": "string" }, "queryParams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "headers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "method": { "type": "string", "enum": [ "POST", "GET", "PUT", "DELETE", "PATCH", "HEAD", "CONNECT", "OPTIONS", "TRACE" ] }, "url": { "type": "string" }, "body": { "type": "string" } }, "required": [ "id", "queryParams", "headers", "method" ], "additionalProperties": false } }, "required": [ "variablesForTest", "responseVariableMapping" ], "additionalProperties": false }, "webhookId": { "type": "string", "description": "Deprecated, use webhook.id instead" } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "OpenAI" ] }, "options": { "anyOf": [ { "type": "object", "properties": { "task": { "not": {} }, "credentialsId": { "type": "string" }, "baseUrl": { "type": "string", "default": "https://api.openai.com/v1" }, "apiVersion": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "properties": { "task": { "type": "string", "enum": [ "Create chat completion" ] }, "model": { "type": "string" }, "messages": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "role": { "type": "string", "enum": [ "system", "user", "assistant" ] }, "content": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "role": { "type": "string", "enum": [ "Messages sequence ✨" ] }, "content": { "type": "object", "properties": { "assistantMessagesVariableId": { "type": "string" }, "userMessagesVariableId": { "type": "string" } }, "additionalProperties": false } }, "required": [ "id", "role" ], "additionalProperties": false } ] } }, "advancedSettings": { "type": "object", "properties": { "temperature": { "anyOf": [ { "type": "number" }, {} ] } }, "additionalProperties": false }, "responseMapping": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "valueToExtract": { "type": "string", "enum": [ "Message content", "Total tokens" ] }, "variableId": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "credentialsId": { "type": "string" }, "baseUrl": { "type": "string", "default": "https://api.openai.com/v1" }, "apiVersion": { "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" ] } }, "additionalProperties": false }, "responseMapping": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "valueToExtract": { "type": "string", "enum": [ "Image URL" ] }, "variableId": { "type": "string" } }, "required": [ "id", "valueToExtract" ], "additionalProperties": false } }, "credentialsId": { "type": "string" }, "baseUrl": { "type": "string", "default": "https://api.openai.com/v1" }, "apiVersion": { "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": { "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" }, "isExecutedOnClient": { "type": "boolean" }, "webhook": { "type": "object", "properties": { "id": { "type": "string" }, "queryParams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "headers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "method": { "type": "string", "enum": [ "POST", "GET", "PUT", "DELETE", "PATCH", "HEAD", "CONNECT", "OPTIONS", "TRACE" ] }, "url": { "type": "string" }, "body": { "type": "string" } }, "required": [ "id", "queryParams", "headers", "method" ], "additionalProperties": false } }, "required": [ "variablesForTest", "responseVariableMapping" ], "additionalProperties": false }, "webhookId": { "type": "string", "description": "Deprecated, use webhook.id instead" } }, "required": [ "id", "groupId", "type", "options" ], "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": { "type": "string" } }, "subject": { "type": "string" }, "body": { "type": "string" }, "replyTo": { "type": "string" }, "cc": { "type": "array", "items": { "type": "string" } }, "bcc": { "type": "array", "items": { "type": "string" } }, "attachmentsVariableId": { "type": "string" } }, "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" }, "variableId": { "type": "string" }, "bodyPath": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "isAdvancedConfig": { "type": "boolean" }, "isCustomBody": { "type": "boolean" }, "isExecutedOnClient": { "type": "boolean" }, "webhook": { "type": "object", "properties": { "id": { "type": "string" }, "queryParams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "headers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "method": { "type": "string", "enum": [ "POST", "GET", "PUT", "DELETE", "PATCH", "HEAD", "CONNECT", "OPTIONS", "TRACE" ] }, "url": { "type": "string" }, "body": { "type": "string" } }, "required": [ "id", "queryParams", "headers", "method" ], "additionalProperties": false } }, "required": [ "variablesForTest", "responseVariableMapping" ], "additionalProperties": false }, "webhookId": { "type": "string", "description": "Deprecated, now integrated in webhook block options" } }, "required": [ "id", "groupId", "type", "options" ], "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" }, "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" }, "isExecutedOnClient": { "type": "boolean" }, "webhook": { "type": "object", "properties": { "id": { "type": "string" }, "queryParams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "headers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "method": { "type": "string", "enum": [ "POST", "GET", "PUT", "DELETE", "PATCH", "HEAD", "CONNECT", "OPTIONS", "TRACE" ] }, "url": { "type": "string" }, "body": { "type": "string" } }, "required": [ "id", "queryParams", "headers", "method" ], "additionalProperties": false } }, "required": [ "variablesForTest", "responseVariableMapping" ], "additionalProperties": false }, "webhookId": { "type": "string", "description": "Deprecated, use webhook.id instead" } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "Pixel" ] }, "options": { "anyOf": [ { "type": "object", "properties": { "pixelId": { "type": "string" }, "isInitSkip": { "type": "boolean" }, "params": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": {} }, "required": [ "id" ], "additionalProperties": false } }, "eventType": { "not": {} } }, "additionalProperties": false }, { "type": "object", "properties": { "pixelId": { "type": "string" }, "isInitSkip": { "type": "boolean" }, "params": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": {} }, "required": [ "id" ], "additionalProperties": false } }, "eventType": { "type": "string", "enum": [ "Lead", "Contact", "CompleteRegistration", "Schedule", "SubmitApplication", "ViewContent", "AddPaymentInfo", "AddToCart", "AddToWishlist", "CustomizeProduct", "Donate", "FindLocation", "InitiateCheckout", "Purchase", "Search", "StartTrial", "Subscribe" ] } }, "required": [ "eventType" ], "additionalProperties": false }, { "type": "object", "properties": { "pixelId": { "type": "string" }, "isInitSkip": { "type": "boolean" }, "params": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "value": {} }, "required": [ "id" ], "additionalProperties": false } }, "eventType": { "type": "string", "enum": [ "Custom" ] }, "name": { "type": "string" } }, "required": [ "eventType" ], "additionalProperties": false } ] } }, "required": [ "id", "groupId", "type", "options" ], "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": { "type": "string", "nullable": true } } ], "nullable": true } }, "required": [ "id", "name" ], "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 }, "roundness": { "type": "string", "enum": [ "none", "medium", "large" ] } }, "required": [ "hostBubbles", "guestBubbles", "buttons", "inputs" ], "additionalProperties": false }, "customCss": { "type": "string" } }, "required": [ "general", "chat" ], "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" }, "rememberUser": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "storage": { "type": "string", "enum": [ "session", "local" ] } }, "additionalProperties": false } }, "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 }, "whatsApp": { "type": "object", "properties": { "credentialsId": { "type": "string" }, "startCondition": { "type": "object", "properties": { "logicalOperator": { "type": "string", "enum": [ "OR", "AND" ] }, "comparisons": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "comparisonOperator": { "type": "string", "enum": [ "Equal to", "Not equal", "Contains", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with", "Matches regex", "Does not match regex" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "logicalOperator", "comparisons" ], "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "general", "typingEmulation", "metadata" ], "additionalProperties": false } }, "required": [ "id", "version", "createdAt", "updatedAt", "typebotId", "groups", "edges", "variables", "theme", "settings" ], "additionalProperties": false, "nullable": true } }, "required": [ "publishedTypebot" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/typebots/{typebotId}/publish": { "post": { "operationId": "typebot-publishTypebot", "summary": "Publish a typebot", "tags": [ "Typebot" ], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "typebotId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "success" ] } }, "required": [ "message" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/typebots/{typebotId}/unpublish": { "post": { "operationId": "typebot-unpublishTypebot", "summary": "Unpublish a typebot", "tags": [ "Typebot" ], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "typebotId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "success" ] } }, "required": [ "message" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/typebots/{typebotId}/webhookBlocks": { "get": { "operationId": "webhook-listWebhookBlocks", "summary": "List webhook blocks", "description": "Returns a list of all the webhook blocks that you can subscribe to.", "tags": [ "Webhook" ], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "typebotId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "webhookBlocks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "Webhook", "Zapier", "Make.com", "Pabbly" ] }, "label": { "type": "string" }, "url": { "type": "string" } }, "required": [ "id", "type", "label" ], "additionalProperties": false } } }, "required": [ "webhookBlocks" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/typebots/{typebotId}/webhookBlocks/{blockId}/getResultExample": { "get": { "operationId": "webhook-getResultExample", "summary": "Get result example", "description": "Returns \"fake\" result for webhook block to help you anticipate how the webhook will behave.", "tags": [ "Webhook" ], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "typebotId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "blockId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "resultExample": { "allOf": [ { "type": "object", "properties": { "message": { "type": "string", "enum": [ "This is a sample result, it has been generated ⬇️" ] }, "Submitted at": { "type": "string" } }, "required": [ "message", "Submitted at" ] }, { "type": "object", "additionalProperties": { "anyOf": [ { "not": {} }, { "type": "string" } ] } } ], "description": "Can contain any fields." } }, "required": [ "resultExample" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/typebots/{typebotId}/webhookBlocks/{blockId}/subscribe": { "post": { "operationId": "webhook-subscribeWebhook", "summary": "Subscribe to webhook block", "tags": [ "Webhook" ], "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ], "additionalProperties": false } } } }, "parameters": [ { "name": "typebotId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "blockId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string", "nullable": true } }, "required": [ "id", "url" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/typebots/{typebotId}/webhookBlocks/{blockId}/unsubscribe": { "post": { "operationId": "webhook-unsubscribeWebhook", "summary": "Unsubscribe from webhook block", "tags": [ "Webhook" ], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "typebotId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "blockId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string", "nullable": true } }, "required": [ "id", "url" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/typebots/{typebotId}/results": { "get": { "operationId": "results-getResults", "summary": "List results ordered by descending creation date", "tags": [ "Results" ], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "typebotId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[0-9]{1,3}$" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "typebotId": { "type": "string" }, "variables": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string", "nullable": true } } ] } }, "required": [ "id", "name", "value" ], "additionalProperties": false } }, "isCompleted": { "type": "boolean" }, "hasStarted": { "type": "boolean", "nullable": true }, "isArchived": { "type": "boolean", "nullable": true }, "answers": { "type": "array", "items": { "type": "object", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "resultId": { "type": "string" }, "blockId": { "type": "string" }, "itemId": { "type": "string", "nullable": true }, "groupId": { "type": "string" }, "variableId": { "type": "string", "nullable": true }, "content": { "type": "string" }, "storageUsed": { "type": "number", "nullable": true } }, "required": [ "createdAt", "resultId", "blockId", "itemId", "groupId", "variableId", "content", "storageUsed" ], "additionalProperties": false } } }, "required": [ "id", "createdAt", "typebotId", "variables", "isCompleted", "hasStarted", "isArchived", "answers" ], "additionalProperties": false } }, "nextCursor": { "type": "string", "nullable": true } }, "required": [ "results" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } }, "delete": { "operationId": "results-deleteResults", "summary": "Delete results", "tags": [ "Results" ], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "typebotId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resultIds", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Comma separated list of ids. If not provided, all results will be deleted. ⚠️" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": {} } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/typebots/{typebotId}/results/{resultId}": { "get": { "operationId": "results-getResult", "summary": "Get result by id", "tags": [ "Results" ], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "typebotId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resultId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "typebotId": { "type": "string" }, "variables": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string", "nullable": true } } ] } }, "required": [ "id", "name", "value" ], "additionalProperties": false } }, "isCompleted": { "type": "boolean" }, "hasStarted": { "type": "boolean", "nullable": true }, "isArchived": { "type": "boolean", "nullable": true }, "answers": { "type": "array", "items": { "type": "object", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "resultId": { "type": "string" }, "blockId": { "type": "string" }, "itemId": { "type": "string", "nullable": true }, "groupId": { "type": "string" }, "variableId": { "type": "string", "nullable": true }, "content": { "type": "string" }, "storageUsed": { "type": "number", "nullable": true } }, "required": [ "createdAt", "resultId", "blockId", "itemId", "groupId", "variableId", "content", "storageUsed" ], "additionalProperties": false } } }, "required": [ "id", "createdAt", "typebotId", "variables", "isCompleted", "hasStarted", "isArchived", "answers" ], "additionalProperties": false } }, "required": [ "result" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/typebots/{typebotId}/results/{resultId}/logs": { "get": { "operationId": "results-getResultLogs", "summary": "List result logs", "tags": [ "Results" ], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "typebotId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resultId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "logs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "resultId": { "type": "string" }, "status": { "type": "string" }, "description": { "type": "string" }, "details": { "type": "string", "nullable": true } }, "required": [ "id", "createdAt", "resultId", "status", "description", "details" ], "additionalProperties": false } } }, "required": [ "logs" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/billing/subscription/portal": { "get": { "operationId": "billing-getBillingPortalUrl", "summary": "Get Stripe billing portal URL", "tags": [ "Billing" ], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "workspaceId", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "billingPortalUrl": { "type": "string" } }, "required": [ "billingPortalUrl" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/billing/invoices": { "get": { "operationId": "billing-listInvoices", "summary": "List invoices", "tags": [ "Billing" ], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "workspaceId", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "invoices": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "amount": { "type": "number" }, "currency": { "type": "string" }, "date": { "type": "number", "nullable": true } }, "required": [ "id", "url", "amount", "currency", "date" ], "additionalProperties": false } } }, "required": [ "invoices" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/billing/subscription/checkout": { "post": { "operationId": "billing-createCheckoutSession", "summary": "Create checkout session to create a new subscription", "tags": [ "Billing" ], "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string" }, "company": { "type": "string" }, "workspaceId": { "type": "string" }, "currency": { "type": "string", "enum": [ "usd", "eur" ] }, "plan": { "type": "string", "enum": [ "STARTER", "PRO" ] }, "returnUrl": { "type": "string" }, "additionalChats": { "type": "number" }, "additionalStorage": { "type": "number" }, "vat": { "type": "object", "properties": { "type": { "type": "string" }, "value": { "type": "string" } }, "required": [ "type", "value" ], "additionalProperties": false }, "isYearly": { "type": "boolean" } }, "required": [ "email", "company", "workspaceId", "currency", "plan", "returnUrl", "additionalChats", "additionalStorage", "isYearly" ], "additionalProperties": false } } } }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "checkoutUrl": { "type": "string" } }, "required": [ "checkoutUrl" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/billing/subscription": { "patch": { "operationId": "billing-updateSubscription", "summary": "Update subscription", "tags": [ "Billing" ], "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "returnUrl": { "type": "string" }, "workspaceId": { "type": "string" }, "plan": { "type": "string", "enum": [ "STARTER", "PRO" ] }, "additionalChats": { "type": "number" }, "additionalStorage": { "type": "number" }, "currency": { "type": "string", "enum": [ "usd", "eur" ] }, "isYearly": { "type": "boolean" } }, "required": [ "returnUrl", "workspaceId", "plan", "additionalChats", "additionalStorage", "currency", "isYearly" ], "additionalProperties": false } } } }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "workspace": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "icon": { "type": "string", "nullable": true }, "plan": { "type": "string", "enum": [ "FREE", "STARTER", "PRO", "LIFETIME", "OFFERED", "CUSTOM", "UNLIMITED" ] }, "stripeId": { "type": "string", "nullable": true }, "additionalChatsIndex": { "type": "number" }, "additionalStorageIndex": { "type": "number" }, "chatsLimitFirstEmailSentAt": { "type": "string", "format": "date-time", "nullable": true }, "chatsLimitSecondEmailSentAt": { "type": "string", "format": "date-time", "nullable": true }, "storageLimitFirstEmailSentAt": { "type": "string", "format": "date-time", "nullable": true }, "storageLimitSecondEmailSentAt": { "type": "string", "format": "date-time", "nullable": true }, "customChatsLimit": { "type": "number", "nullable": true }, "customStorageLimit": { "type": "number", "nullable": true }, "customSeatsLimit": { "type": "number", "nullable": true }, "isQuarantined": { "type": "boolean" }, "isSuspended": { "type": "boolean" } }, "required": [ "id", "createdAt", "updatedAt", "name", "icon", "plan", "stripeId", "additionalChatsIndex", "additionalStorageIndex", "chatsLimitFirstEmailSentAt", "chatsLimitSecondEmailSentAt", "storageLimitFirstEmailSentAt", "storageLimitSecondEmailSentAt", "customChatsLimit", "customStorageLimit", "customSeatsLimit", "isQuarantined", "isSuspended" ], "additionalProperties": false, "nullable": true }, "checkoutUrl": { "type": "string", "nullable": true } }, "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } }, "get": { "operationId": "billing-getSubscription", "summary": "List invoices", "tags": [ "Billing" ], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "workspaceId", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "subscription": { "anyOf": [ { "type": "object", "properties": { "isYearly": { "type": "boolean" }, "currency": { "type": "string", "enum": [ "eur", "usd" ] }, "cancelDate": { "type": "string", "format": "date-time" } }, "required": [ "isYearly", "currency" ], "additionalProperties": false }, { "enum": [ "null" ], "nullable": true } ] } }, "required": [ "subscription" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/billing/usage": { "get": { "operationId": "billing-getUsage", "summary": "Get current plan usage", "tags": [ "Billing" ], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "workspaceId", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "totalChatsUsed": { "type": "number" }, "totalStorageUsed": { "type": "number" } }, "required": [ "totalChatsUsed", "totalStorageUsed" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/billing/subscription/custom-checkout": { "post": { "operationId": "billing-createCustomCheckoutSession", "summary": "Create custom checkout session to make a workspace pay for a custom plan", "tags": [ "Billing" ], "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string" }, "workspaceId": { "type": "string" }, "returnUrl": { "type": "string" } }, "required": [ "email", "workspaceId", "returnUrl" ], "additionalProperties": false } } } }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "checkoutUrl": { "type": "string" } }, "required": [ "checkoutUrl" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/credentials": { "post": { "operationId": "credentials-createCredentials", "summary": "Create credentials", "tags": [ "Credentials" ], "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "credentials": { "anyOf": [ { "type": "object", "properties": { "data": { "type": "object", "properties": { "live": { "type": "object", "properties": { "secretKey": { "type": "string" }, "publicKey": { "type": "string" } }, "required": [ "secretKey", "publicKey" ], "additionalProperties": false }, "test": { "type": "object", "properties": { "secretKey": { "type": "string" }, "publicKey": { "type": "string" } }, "additionalProperties": false } }, "required": [ "live", "test" ], "additionalProperties": false }, "type": { "type": "string", "enum": [ "stripe" ] }, "workspaceId": { "type": "string" }, "name": { "type": "string" } }, "required": [ "data", "type", "workspaceId", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "data": { "type": "object", "properties": { "host": { "type": "string" }, "username": { "type": "string" }, "password": { "type": "string" }, "isTlsEnabled": { "type": "boolean" }, "port": { "type": "number" }, "from": { "type": "object", "properties": { "email": { "type": "string" }, "name": { "type": "string" } }, "additionalProperties": false } }, "required": [ "port", "from" ], "additionalProperties": false }, "type": { "type": "string", "enum": [ "smtp" ] }, "workspaceId": { "type": "string" }, "name": { "type": "string" } }, "required": [ "data", "type", "workspaceId", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "data": { "type": "object", "properties": { "refresh_token": { "type": "string", "nullable": true }, "expiry_date": { "type": "number", "nullable": true }, "access_token": { "type": "string", "nullable": true }, "token_type": { "type": "string", "nullable": true }, "id_token": { "type": "string", "nullable": true }, "scope": { "type": "string" } }, "additionalProperties": false }, "type": { "type": "string", "enum": [ "google sheets" ] }, "workspaceId": { "type": "string" }, "name": { "type": "string" } }, "required": [ "data", "type", "workspaceId", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "data": { "type": "object", "properties": { "apiKey": { "type": "string" } }, "required": [ "apiKey" ], "additionalProperties": false }, "type": { "type": "string", "enum": [ "openai" ] }, "workspaceId": { "type": "string" }, "name": { "type": "string" } }, "required": [ "data", "type", "workspaceId", "name" ], "additionalProperties": false }, { "type": "object", "properties": { "data": { "type": "object", "properties": { "systemUserAccessToken": { "type": "string" }, "phoneNumberId": { "type": "string" } }, "required": [ "systemUserAccessToken", "phoneNumberId" ], "additionalProperties": false }, "type": { "type": "string", "enum": [ "whatsApp" ] }, "workspaceId": { "type": "string" }, "name": { "type": "string" } }, "required": [ "data", "type", "workspaceId", "name" ], "additionalProperties": false } ] } }, "required": [ "credentials" ], "additionalProperties": false } } } }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "credentialsId": { "type": "string" } }, "required": [ "credentialsId" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } }, "get": { "operationId": "credentials-listCredentials", "summary": "List workspace credentials", "tags": [ "Credentials" ], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "workspaceId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": true, "schema": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "stripe" ] }, { "type": "string", "enum": [ "smtp" ] } ] }, { "type": "string", "enum": [ "google sheets" ] } ] }, { "type": "string", "enum": [ "openai" ] } ] }, { "type": "string", "enum": [ "whatsApp" ] } ] } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "credentials": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } } }, "required": [ "credentials" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/credentials/:credentialsId": { "delete": { "operationId": "credentials-deleteCredentials", "summary": "Delete credentials", "tags": [ "Credentials" ], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "credentialsId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "credentialsId": { "type": "string" } }, "required": [ "credentialsId" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/themeTemplates": { "get": { "operationId": "theme-listThemeTemplates", "summary": "List theme templates", "tags": [ "Theme template" ], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "workspaceId", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "themeTemplates": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "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 }, "roundness": { "type": "string", "enum": [ "none", "medium", "large" ] } }, "required": [ "hostBubbles", "guestBubbles", "buttons", "inputs" ], "additionalProperties": false }, "customCss": { "type": "string" } }, "required": [ "general", "chat" ], "additionalProperties": false } }, "required": [ "id", "name", "theme" ], "additionalProperties": false } } }, "required": [ "themeTemplates" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/themeTemplates/{themeTemplateId}": { "put": { "operationId": "theme-saveThemeTemplate", "summary": "Save theme template", "tags": [ "Theme template" ], "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "workspaceId": { "type": "string" }, "name": { "type": "string" }, "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 }, "roundness": { "type": "string", "enum": [ "none", "medium", "large" ] } }, "required": [ "hostBubbles", "guestBubbles", "buttons", "inputs" ], "additionalProperties": false }, "customCss": { "type": "string" } }, "required": [ "general", "chat" ], "additionalProperties": false } }, "required": [ "workspaceId", "name", "theme" ], "additionalProperties": false } } } }, "parameters": [ { "name": "themeTemplateId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "themeTemplate": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "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 }, "roundness": { "type": "string", "enum": [ "none", "medium", "large" ] } }, "required": [ "hostBubbles", "guestBubbles", "buttons", "inputs" ], "additionalProperties": false }, "customCss": { "type": "string" } }, "required": [ "general", "chat" ], "additionalProperties": false }, "workspaceId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "name", "theme", "workspaceId", "createdAt", "updatedAt" ], "additionalProperties": false } }, "required": [ "themeTemplate" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } }, "delete": { "operationId": "theme-deleteThemeTemplate", "summary": "Delete a theme template", "tags": [ "Theme template" ], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "workspaceId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "themeTemplateId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "themeTemplate": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "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 }, "roundness": { "type": "string", "enum": [ "none", "medium", "large" ] } }, "required": [ "hostBubbles", "guestBubbles", "buttons", "inputs" ], "additionalProperties": false }, "customCss": { "type": "string" } }, "required": [ "general", "chat" ], "additionalProperties": false }, "workspaceId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "name", "theme", "workspaceId", "createdAt", "updatedAt" ], "additionalProperties": false } }, "required": [ "themeTemplate" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/typebots/{typebotId}/collaborators": { "get": { "operationId": "collaborators-getCollaborators", "summary": "Get collaborators", "tags": [ "Collaborators" ], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "typebotId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "collaborators": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "READ", "WRITE", "FULL_ACCESS" ] }, "userId": { "type": "string" }, "typebotId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "type", "userId", "typebotId", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "required": [ "collaborators" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/custom-domains": { "post": { "operationId": "customDomains-createCustomDomain", "summary": "Create custom domain", "tags": [ "Custom domains" ], "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "workspaceId": { "type": "string" }, "name": { "type": "string" } }, "required": [ "workspaceId", "name" ], "additionalProperties": false } } } }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "customDomain": { "type": "object", "properties": { "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "name", "createdAt" ], "additionalProperties": false } }, "required": [ "customDomain" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } }, "delete": { "operationId": "customDomains-deleteCustomDomain", "summary": "Delete custom domain", "tags": [ "Custom domains" ], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "workspaceId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "success" ] } }, "required": [ "message" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } }, "get": { "operationId": "customDomains-listCustomDomains", "summary": "List custom domains", "tags": [ "Custom domains" ], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "workspaceId", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "customDomains": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "name", "createdAt" ], "additionalProperties": false } } }, "required": [ "customDomains" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/whatsapp/phoneNumber": { "get": { "operationId": "whatsApp-getPhoneNumber", "security": [ { "Authorization": [] } ], "parameters": [ { "name": "credentialsId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "systemToken", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "phoneNumberId", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/whatsapp/systemToken": { "get": { "operationId": "whatsApp-getSystemTokenInfo", "security": [ { "Authorization": [] } ], "parameters": [ { "name": "token", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "credentialsId", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "appId": { "type": "string" }, "appName": { "type": "string" }, "expiresAt": { "type": "number" }, "scopes": { "type": "array", "items": { "type": "string" } } }, "required": [ "appId", "appName", "expiresAt", "scopes" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/whatsapp/phoneNumber/{phoneNumberDisplayName}/available": { "get": { "operationId": "whatsApp-verifyIfPhoneNumberAvailable", "security": [ { "Authorization": [] } ], "parameters": [ { "name": "phoneNumberDisplayName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "enum": [ "available", "taken" ] } }, "required": [ "message" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/verficiationTokens": { "post": { "operationId": "whatsApp-generateVerificationToken", "security": [ { "Authorization": [] } ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "verificationToken": { "type": "string" } }, "required": [ "verificationToken" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/typebots/{typebotId}/blocks/{blockId}/openai/models": { "get": { "operationId": "openAI-listModels", "summary": "List OpenAI models", "tags": [ "OpenAI" ], "security": [ { "Authorization": [] } ], "parameters": [ { "name": "typebotId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "blockId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "credentialsId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "models": { "type": "array", "items": { "type": "string" } } }, "required": [ "models" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } } }, "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" } }