7cf1a3e26d
Closes #1249 <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Introduced components for customizing fonts, including Google and custom font options. - Enhanced theme customization by simplifying theme objects and adding new font customization options. - Implemented dynamic font injection for web pages based on user-selected font configurations. - **Bug Fixes** - Fixed a condition in theme template card rendering to correctly check avatar enablement. - Corrected font property handling across various components to support both string and object types. - **Refactor** - Updated option properties in RadioButtons component to be readonly. - Simplified logic for setting CSS variables for fonts, including checks for font types and existence. - **Documentation** - Added constants and schemas for supporting new font types in theme customization. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
25361 lines
1.0 MiB
25361 lines
1.0 MiB
{
|
|
"openapi": "3.0.3",
|
|
"info": {
|
|
"title": "Builder API",
|
|
"version": "1.0.0"
|
|
},
|
|
"servers": [
|
|
{
|
|
"url": "https://app.typebot.io/api"
|
|
}
|
|
],
|
|
"externalDocs": {
|
|
"url": "https://docs.typebot.io/api-reference"
|
|
},
|
|
"paths": {
|
|
"/v1/typebots/{typebotId}/linkedTypebots": {
|
|
"get": {
|
|
"operationId": "getLinkedTypebots",
|
|
"summary": "Get linked typebots",
|
|
"tags": [
|
|
"Typebot"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "typebotId",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"typebots": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"version": {
|
|
"type": "string",
|
|
"enum": [
|
|
"3",
|
|
"4",
|
|
"5"
|
|
]
|
|
},
|
|
"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"
|
|
]
|
|
},
|
|
"blocks": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"start"
|
|
]
|
|
},
|
|
"label": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type",
|
|
"label"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"text"
|
|
]
|
|
},
|
|
"content": {
|
|
"type": "object",
|
|
"properties": {
|
|
"html": {
|
|
"type": "string"
|
|
},
|
|
"richText": {
|
|
"type": "array",
|
|
"items": {}
|
|
},
|
|
"plainText": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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",
|
|
"tiktok",
|
|
"gumlet"
|
|
]
|
|
},
|
|
"height": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{}
|
|
]
|
|
},
|
|
"aspectRatio": {
|
|
"type": "string"
|
|
},
|
|
"maxWidth": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"embed"
|
|
]
|
|
},
|
|
"content": {
|
|
"type": "object",
|
|
"properties": {
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"height": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"audio"
|
|
]
|
|
},
|
|
"content": {
|
|
"type": "object",
|
|
"properties": {
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"isAutoplayEnabled": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/textInput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/buttonsInputV5"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/email"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/numberInput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/url"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/phoneNumberInput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/dateInput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/paymentInput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/rating"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/fileInputV5"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/pictureChoiceV5"
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Code"
|
|
]
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"shouldExecuteInParentContext": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Condition"
|
|
]
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type",
|
|
"items"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Redirect"
|
|
]
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"isNewTab": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Set variable"
|
|
]
|
|
},
|
|
"options": {
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"expressionToEvaluate": {
|
|
"type": "string"
|
|
},
|
|
"isCode": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Now",
|
|
"Yesterday",
|
|
"Tomorrow"
|
|
]
|
|
},
|
|
"timeZone": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Today",
|
|
"Moment of the day",
|
|
"Empty",
|
|
"Environment name",
|
|
"User ID",
|
|
"Result ID",
|
|
"Random ID",
|
|
"Phone number",
|
|
"Contact name"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Custom"
|
|
]
|
|
},
|
|
"expressionToEvaluate": {
|
|
"type": "string"
|
|
},
|
|
"isCode": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Map item with same index"
|
|
]
|
|
},
|
|
"mapListItemParams": {
|
|
"type": "object",
|
|
"properties": {
|
|
"baseItemVariableId": {
|
|
"type": "string"
|
|
},
|
|
"baseListVariableId": {
|
|
"type": "string"
|
|
},
|
|
"targetListVariableId": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Append value(s)"
|
|
]
|
|
},
|
|
"item": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Typebot link"
|
|
]
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"typebotId": {
|
|
"type": "string"
|
|
},
|
|
"groupId": {
|
|
"type": "string"
|
|
},
|
|
"mergeResults": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Wait"
|
|
]
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"secondsToWaitFor": {
|
|
"type": "string"
|
|
},
|
|
"shouldPause": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Jump"
|
|
]
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"groupId": {
|
|
"type": "string"
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"AB test"
|
|
]
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"maxItems": 2,
|
|
"minItems": 2,
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"path": {
|
|
"type": "string",
|
|
"enum": [
|
|
"a"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"path"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"path": {
|
|
"type": "string",
|
|
"enum": [
|
|
"b"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"path"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"aPercent": {
|
|
"type": "number",
|
|
"minimum": 0,
|
|
"maximum": 100
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type",
|
|
"items"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Google Sheets"
|
|
]
|
|
},
|
|
"options": {
|
|
"oneOf": [
|
|
{
|
|
"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"
|
|
]
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"logicalOperator": {
|
|
"type": "string",
|
|
"enum": [
|
|
"OR",
|
|
"AND"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"cellsToExtract": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"column": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"totalRowsToExtract": {
|
|
"type": "string",
|
|
"enum": [
|
|
"All",
|
|
"First",
|
|
"Last",
|
|
"Random"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"action"
|
|
]
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"action"
|
|
]
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"referenceCell": {
|
|
"type": "object",
|
|
"properties": {
|
|
"column": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"logicalOperator": {
|
|
"type": "string",
|
|
"enum": [
|
|
"OR",
|
|
"AND"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"action"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"sheetId": {
|
|
"type": "string"
|
|
},
|
|
"spreadsheetId": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"responseVariableMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"bodyPath": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"headers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"method": {
|
|
"type": "string",
|
|
"enum": [
|
|
"POST",
|
|
"GET",
|
|
"PUT",
|
|
"DELETE",
|
|
"PATCH",
|
|
"HEAD",
|
|
"CONNECT",
|
|
"OPTIONS",
|
|
"TRACE"
|
|
]
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"body": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"timeout": {
|
|
"type": "number",
|
|
"minimum": 1,
|
|
"maximum": 120
|
|
}
|
|
}
|
|
},
|
|
"webhookId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"OpenAI"
|
|
]
|
|
},
|
|
"options": {
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"baseUrl": {
|
|
"type": "string"
|
|
},
|
|
"apiVersion": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"role": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Messages sequence ✨"
|
|
]
|
|
},
|
|
"content": {
|
|
"type": "object",
|
|
"properties": {
|
|
"assistantMessagesVariableId": {
|
|
"type": "string"
|
|
},
|
|
"userMessagesVariableId": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"role"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"role": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Dialogue"
|
|
]
|
|
},
|
|
"dialogueVariableId": {
|
|
"type": "string"
|
|
},
|
|
"startsBy": {
|
|
"type": "string",
|
|
"enum": [
|
|
"user",
|
|
"assistant"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"role"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"advancedSettings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"temperature": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"responseMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"valueToExtract": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Message content",
|
|
"Total tokens"
|
|
]
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"valueToExtract"
|
|
]
|
|
}
|
|
},
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"baseUrl": {
|
|
"type": "string"
|
|
},
|
|
"apiVersion": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"task"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"task": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Create image"
|
|
]
|
|
},
|
|
"prompt": {
|
|
"type": "string"
|
|
},
|
|
"advancedOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"size": {
|
|
"type": "string",
|
|
"enum": [
|
|
"256x256",
|
|
"512x512",
|
|
"1024x1024"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"responseMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"valueToExtract": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Image URL"
|
|
]
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"valueToExtract"
|
|
]
|
|
}
|
|
},
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"baseUrl": {
|
|
"type": "string"
|
|
},
|
|
"apiVersion": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"task",
|
|
"advancedOptions",
|
|
"responseMapping"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"baseUrl": {
|
|
"type": "string"
|
|
},
|
|
"apiVersion": {
|
|
"type": "string"
|
|
},
|
|
"task": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Create speech"
|
|
]
|
|
},
|
|
"model": {
|
|
"type": "string"
|
|
},
|
|
"input": {
|
|
"type": "string"
|
|
},
|
|
"voice": {
|
|
"type": "string",
|
|
"enum": [
|
|
"alloy",
|
|
"echo",
|
|
"fable",
|
|
"onyx",
|
|
"nova",
|
|
"shimmer"
|
|
]
|
|
},
|
|
"saveUrlInVariableId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"task"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"responseVariableMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"bodyPath": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"headers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"method": {
|
|
"type": "string",
|
|
"enum": [
|
|
"POST",
|
|
"GET",
|
|
"PUT",
|
|
"DELETE",
|
|
"PATCH",
|
|
"HEAD",
|
|
"CONNECT",
|
|
"OPTIONS",
|
|
"TRACE"
|
|
]
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"body": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"timeout": {
|
|
"type": "number",
|
|
"minimum": 1,
|
|
"maximum": 120
|
|
}
|
|
}
|
|
},
|
|
"webhookId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Webhook"
|
|
],
|
|
"description": "Legacy name for HTTP Request block"
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"variablesForTest": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"responseVariableMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"bodyPath": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"headers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"method": {
|
|
"type": "string",
|
|
"enum": [
|
|
"POST",
|
|
"GET",
|
|
"PUT",
|
|
"DELETE",
|
|
"PATCH",
|
|
"HEAD",
|
|
"CONNECT",
|
|
"OPTIONS",
|
|
"TRACE"
|
|
]
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"body": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"timeout": {
|
|
"type": "number",
|
|
"minimum": 1,
|
|
"maximum": 120
|
|
}
|
|
}
|
|
},
|
|
"webhookId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"responseVariableMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"bodyPath": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"headers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"method": {
|
|
"type": "string",
|
|
"enum": [
|
|
"POST",
|
|
"GET",
|
|
"PUT",
|
|
"DELETE",
|
|
"PATCH",
|
|
"HEAD",
|
|
"CONNECT",
|
|
"OPTIONS",
|
|
"TRACE"
|
|
]
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"body": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"timeout": {
|
|
"type": "number",
|
|
"minimum": 1,
|
|
"maximum": 120
|
|
}
|
|
}
|
|
},
|
|
"webhookId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Pixel"
|
|
]
|
|
},
|
|
"options": {
|
|
"oneOf": [
|
|
{
|
|
"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"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"eventType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Lead",
|
|
"Contact",
|
|
"CompleteRegistration",
|
|
"Schedule",
|
|
"SubmitApplication",
|
|
"ViewContent",
|
|
"AddPaymentInfo",
|
|
"AddToCart",
|
|
"AddToWishlist",
|
|
"CustomizeProduct",
|
|
"Donate",
|
|
"FindLocation",
|
|
"InitiateCheckout",
|
|
"Purchase",
|
|
"Search",
|
|
"StartTrial",
|
|
"Subscribe"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"eventType"
|
|
]
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"eventType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Custom"
|
|
]
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"eventType"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Zemantic AI"
|
|
]
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"systemPrompt": {
|
|
"type": "string"
|
|
},
|
|
"prompt": {
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"type": "string"
|
|
},
|
|
"maxResults": {
|
|
"type": "integer"
|
|
},
|
|
"responseMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"valueToExtract": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Summary",
|
|
"Results"
|
|
]
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"valueToExtract"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"title",
|
|
"graphCoordinates",
|
|
"blocks"
|
|
]
|
|
}
|
|
},
|
|
"variables": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"nullable": true,
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"name"
|
|
]
|
|
}
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"version",
|
|
"groups",
|
|
"variables",
|
|
"name"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"version": {
|
|
"type": "string",
|
|
"enum": [
|
|
"6"
|
|
]
|
|
},
|
|
"groups": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/groupV6"
|
|
}
|
|
},
|
|
"variables": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"nullable": true,
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"name"
|
|
]
|
|
}
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"version",
|
|
"groups",
|
|
"variables",
|
|
"name"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"typebots"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/typebots/{typebotId}/analytics/totalAnswersInBlocks": {
|
|
"get": {
|
|
"operationId": "analytics-getTotalAnswers",
|
|
"summary": "List total answers in blocks",
|
|
"tags": [
|
|
"Analytics"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "typebotId",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timeFilter",
|
|
"schema": {
|
|
"type": "string",
|
|
"enum": [
|
|
"today",
|
|
"last7Days",
|
|
"last30Days",
|
|
"yearToDate",
|
|
"allTime"
|
|
],
|
|
"default": "today"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"totalAnswers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"blockId": {
|
|
"type": "string"
|
|
},
|
|
"itemId": {
|
|
"type": "string"
|
|
},
|
|
"total": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"blockId",
|
|
"total"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"totalAnswers"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/typebots/{typebotId}/analytics/totalVisitedEdges": {
|
|
"get": {
|
|
"operationId": "analytics-getTotalVisitedEdges",
|
|
"summary": "List total edges used in results",
|
|
"tags": [
|
|
"Analytics"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "typebotId",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timeFilter",
|
|
"schema": {
|
|
"type": "string",
|
|
"enum": [
|
|
"today",
|
|
"last7Days",
|
|
"last30Days",
|
|
"yearToDate",
|
|
"allTime"
|
|
],
|
|
"default": "today"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"totalVisitedEdges": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"edgeId": {
|
|
"type": "string"
|
|
},
|
|
"total": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"edgeId",
|
|
"total"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"totalVisitedEdges"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/typebots/{typebotId}/analytics/stats": {
|
|
"get": {
|
|
"operationId": "analytics-getStats",
|
|
"summary": "Get results stats",
|
|
"tags": [
|
|
"Analytics"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "typebotId",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timeFilter",
|
|
"schema": {
|
|
"type": "string",
|
|
"enum": [
|
|
"today",
|
|
"last7Days",
|
|
"last30Days",
|
|
"yearToDate",
|
|
"allTime"
|
|
],
|
|
"default": "today"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"stats": {
|
|
"type": "object",
|
|
"properties": {
|
|
"totalViews": {
|
|
"type": "number"
|
|
},
|
|
"totalStarts": {
|
|
"type": "number"
|
|
},
|
|
"totalCompleted": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"totalViews",
|
|
"totalStarts",
|
|
"totalCompleted"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"stats"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/workspaces": {
|
|
"get": {
|
|
"operationId": "workspace-listWorkspaces",
|
|
"summary": "List workspaces",
|
|
"tags": [
|
|
"Workspace"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"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"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"workspaces"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_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"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"workspace": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"createdAt": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"icon": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"plan": {
|
|
"type": "string",
|
|
"enum": [
|
|
"FREE",
|
|
"STARTER",
|
|
"PRO",
|
|
"LIFETIME",
|
|
"OFFERED",
|
|
"CUSTOM",
|
|
"UNLIMITED"
|
|
]
|
|
},
|
|
"stripeId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"isSuspended": {
|
|
"type": "boolean"
|
|
},
|
|
"isPastDue": {
|
|
"type": "boolean"
|
|
},
|
|
"isVerified": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"icon",
|
|
"plan",
|
|
"stripeId",
|
|
"isSuspended",
|
|
"isPastDue",
|
|
"isVerified"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"workspace"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/workspaces/{workspaceId}": {
|
|
"get": {
|
|
"operationId": "workspace-getWorkspace",
|
|
"summary": "Get workspace",
|
|
"tags": [
|
|
"Workspace"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "workspaceId",
|
|
"description": "[Where to find my workspace ID?](../how-to#how-to-find-my-workspaceid)",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "[Where to find my workspace ID?](../how-to#how-to-find-my-workspaceid)"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"workspace": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"createdAt": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"icon": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"plan": {
|
|
"type": "string",
|
|
"enum": [
|
|
"FREE",
|
|
"STARTER",
|
|
"PRO",
|
|
"LIFETIME",
|
|
"OFFERED",
|
|
"CUSTOM",
|
|
"UNLIMITED"
|
|
]
|
|
},
|
|
"stripeId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"customChatsLimit": {
|
|
"type": "number",
|
|
"nullable": true
|
|
},
|
|
"customSeatsLimit": {
|
|
"type": "number",
|
|
"nullable": true
|
|
},
|
|
"isSuspended": {
|
|
"type": "boolean"
|
|
},
|
|
"isPastDue": {
|
|
"type": "boolean"
|
|
},
|
|
"isVerified": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"icon",
|
|
"plan",
|
|
"stripeId",
|
|
"customChatsLimit",
|
|
"customSeatsLimit",
|
|
"isSuspended",
|
|
"isPastDue",
|
|
"isVerified"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"workspace"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"operationId": "workspace-updateWorkspace",
|
|
"summary": "Update workspace",
|
|
"tags": [
|
|
"Workspace"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "workspaceId",
|
|
"description": "[Where to find my workspace ID?](../how-to#how-to-find-my-workspaceid)",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "[Where to find my workspace ID?](../how-to#how-to-find-my-workspaceid)"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"icon": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"workspace": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"icon": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"icon"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"workspace"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"operationId": "workspace-deleteWorkspace",
|
|
"summary": "Delete workspace",
|
|
"tags": [
|
|
"Workspace"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "workspaceId",
|
|
"description": "[Where to find my workspace ID?](../how-to#how-to-find-my-workspaceid)",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "[Where to find my workspace ID?](../how-to#how-to-find-my-workspaceid)"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"message": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"message"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/workspaces/{workspaceId}/members": {
|
|
"get": {
|
|
"operationId": "workspace-listMembersInWorkspace",
|
|
"summary": "List members in workspace",
|
|
"tags": [
|
|
"Workspace"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "workspaceId",
|
|
"description": "[Where to find my workspace ID?](../how-to#how-to-find-my-workspaceid)",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "[Where to find my workspace ID?](../how-to#how-to-find-my-workspaceid)"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"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"
|
|
]
|
|
},
|
|
"role": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ADMIN",
|
|
"MEMBER",
|
|
"GUEST"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"workspaceId",
|
|
"user",
|
|
"role"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"members"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/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": {
|
|
"$ref": "#/components/schemas/groupV6"
|
|
}
|
|
},
|
|
"events": {
|
|
"type": "array",
|
|
"maxItems": 1,
|
|
"minItems": 1,
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/event"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"theme": {
|
|
"$ref": "#/components/schemas/theme"
|
|
},
|
|
"settings": {
|
|
"$ref": "#/components/schemas/settings"
|
|
},
|
|
"folderId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"variables": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"nullable": true,
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"name"
|
|
]
|
|
}
|
|
},
|
|
"edges": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"from": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"blockId": {
|
|
"type": "string"
|
|
},
|
|
"itemId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"blockId"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"eventId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"eventId"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"to": {
|
|
"type": "object",
|
|
"properties": {
|
|
"groupId": {
|
|
"type": "string"
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"groupId"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"from",
|
|
"to"
|
|
]
|
|
}
|
|
},
|
|
"resultsTablePreferences": {
|
|
"type": "object",
|
|
"nullable": true,
|
|
"properties": {
|
|
"columnsOrder": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"columnsVisibility": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"columnsWidth": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "number"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"columnsOrder",
|
|
"columnsVisibility",
|
|
"columnsWidth"
|
|
]
|
|
},
|
|
"publicId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"customDomain": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"workspaceId",
|
|
"typebot"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"typebot": {
|
|
"$ref": "#/components/schemas/typebotV6"
|
|
}
|
|
},
|
|
"required": [
|
|
"typebot"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"operationId": "typebot-listTypebots",
|
|
"summary": "List typebots",
|
|
"tags": [
|
|
"Typebot"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "query",
|
|
"name": "workspaceId",
|
|
"description": "[Where to find my workspace ID?](../how-to#how-to-find-my-workspaceid)",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "[Where to find my workspace ID?](../how-to#how-to-find-my-workspaceid)"
|
|
},
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "folderId",
|
|
"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"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"typebots"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/typebots/{typebotId}": {
|
|
"patch": {
|
|
"operationId": "typebot-updateTypebot",
|
|
"summary": "Update a typebot",
|
|
"tags": [
|
|
"Typebot"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "typebotId",
|
|
"description": "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"typebot": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"version": {
|
|
"type": "string",
|
|
"enum": [
|
|
"6"
|
|
]
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"icon": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"selectedThemeTemplateId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"groups": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/groupV6"
|
|
}
|
|
},
|
|
"theme": {
|
|
"$ref": "#/components/schemas/theme"
|
|
},
|
|
"settings": {
|
|
"$ref": "#/components/schemas/settings"
|
|
},
|
|
"folderId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"variables": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"nullable": true,
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"name"
|
|
]
|
|
}
|
|
},
|
|
"edges": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"from": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"blockId": {
|
|
"type": "string"
|
|
},
|
|
"itemId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"blockId"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"eventId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"eventId"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"to": {
|
|
"type": "object",
|
|
"properties": {
|
|
"groupId": {
|
|
"type": "string"
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"groupId"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"from",
|
|
"to"
|
|
]
|
|
}
|
|
},
|
|
"resultsTablePreferences": {
|
|
"type": "object",
|
|
"nullable": true,
|
|
"properties": {
|
|
"columnsOrder": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"columnsVisibility": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"columnsWidth": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "number"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"columnsOrder",
|
|
"columnsVisibility",
|
|
"columnsWidth"
|
|
]
|
|
},
|
|
"publicId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"customDomain": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"isClosed": {
|
|
"type": "boolean"
|
|
},
|
|
"whatsAppCredentialsId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"riskLevel": {
|
|
"type": "number",
|
|
"nullable": true
|
|
},
|
|
"events": {
|
|
"type": "array",
|
|
"maxItems": 1,
|
|
"minItems": 1,
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/event"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"updatedAt": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "Typebot V6"
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"version": {
|
|
"type": "string",
|
|
"enum": [
|
|
"3",
|
|
"4",
|
|
"5"
|
|
]
|
|
},
|
|
"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"
|
|
]
|
|
},
|
|
"blocks": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"start"
|
|
]
|
|
},
|
|
"label": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type",
|
|
"label"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"text"
|
|
]
|
|
},
|
|
"content": {
|
|
"type": "object",
|
|
"properties": {
|
|
"html": {
|
|
"type": "string"
|
|
},
|
|
"richText": {
|
|
"type": "array",
|
|
"items": {}
|
|
},
|
|
"plainText": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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",
|
|
"tiktok",
|
|
"gumlet"
|
|
]
|
|
},
|
|
"height": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{}
|
|
]
|
|
},
|
|
"aspectRatio": {
|
|
"type": "string"
|
|
},
|
|
"maxWidth": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"embed"
|
|
]
|
|
},
|
|
"content": {
|
|
"type": "object",
|
|
"properties": {
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"height": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"audio"
|
|
]
|
|
},
|
|
"content": {
|
|
"type": "object",
|
|
"properties": {
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"isAutoplayEnabled": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/textInput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/buttonsInputV5"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/email"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/numberInput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/url"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/phoneNumberInput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/dateInput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/paymentInput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/rating"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/fileInputV5"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/pictureChoiceV5"
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Code"
|
|
]
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"shouldExecuteInParentContext": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Condition"
|
|
]
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type",
|
|
"items"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Redirect"
|
|
]
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"isNewTab": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Set variable"
|
|
]
|
|
},
|
|
"options": {
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"expressionToEvaluate": {
|
|
"type": "string"
|
|
},
|
|
"isCode": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Now",
|
|
"Yesterday",
|
|
"Tomorrow"
|
|
]
|
|
},
|
|
"timeZone": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Today",
|
|
"Moment of the day",
|
|
"Empty",
|
|
"Environment name",
|
|
"User ID",
|
|
"Result ID",
|
|
"Random ID",
|
|
"Phone number",
|
|
"Contact name"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Custom"
|
|
]
|
|
},
|
|
"expressionToEvaluate": {
|
|
"type": "string"
|
|
},
|
|
"isCode": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Map item with same index"
|
|
]
|
|
},
|
|
"mapListItemParams": {
|
|
"type": "object",
|
|
"properties": {
|
|
"baseItemVariableId": {
|
|
"type": "string"
|
|
},
|
|
"baseListVariableId": {
|
|
"type": "string"
|
|
},
|
|
"targetListVariableId": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Append value(s)"
|
|
]
|
|
},
|
|
"item": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Typebot link"
|
|
]
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"typebotId": {
|
|
"type": "string"
|
|
},
|
|
"groupId": {
|
|
"type": "string"
|
|
},
|
|
"mergeResults": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Wait"
|
|
]
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"secondsToWaitFor": {
|
|
"type": "string"
|
|
},
|
|
"shouldPause": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Jump"
|
|
]
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"groupId": {
|
|
"type": "string"
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"AB test"
|
|
]
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"maxItems": 2,
|
|
"minItems": 2,
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"path": {
|
|
"type": "string",
|
|
"enum": [
|
|
"a"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"path"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"path": {
|
|
"type": "string",
|
|
"enum": [
|
|
"b"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"path"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"aPercent": {
|
|
"type": "number",
|
|
"minimum": 0,
|
|
"maximum": 100
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type",
|
|
"items"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Google Sheets"
|
|
]
|
|
},
|
|
"options": {
|
|
"oneOf": [
|
|
{
|
|
"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"
|
|
]
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"logicalOperator": {
|
|
"type": "string",
|
|
"enum": [
|
|
"OR",
|
|
"AND"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"cellsToExtract": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"column": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"totalRowsToExtract": {
|
|
"type": "string",
|
|
"enum": [
|
|
"All",
|
|
"First",
|
|
"Last",
|
|
"Random"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"action"
|
|
]
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"action"
|
|
]
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"referenceCell": {
|
|
"type": "object",
|
|
"properties": {
|
|
"column": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"logicalOperator": {
|
|
"type": "string",
|
|
"enum": [
|
|
"OR",
|
|
"AND"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"action"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"sheetId": {
|
|
"type": "string"
|
|
},
|
|
"spreadsheetId": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"responseVariableMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"bodyPath": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"headers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"method": {
|
|
"type": "string",
|
|
"enum": [
|
|
"POST",
|
|
"GET",
|
|
"PUT",
|
|
"DELETE",
|
|
"PATCH",
|
|
"HEAD",
|
|
"CONNECT",
|
|
"OPTIONS",
|
|
"TRACE"
|
|
]
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"body": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"timeout": {
|
|
"type": "number",
|
|
"minimum": 1,
|
|
"maximum": 120
|
|
}
|
|
}
|
|
},
|
|
"webhookId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"OpenAI"
|
|
]
|
|
},
|
|
"options": {
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"baseUrl": {
|
|
"type": "string"
|
|
},
|
|
"apiVersion": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"role": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Messages sequence ✨"
|
|
]
|
|
},
|
|
"content": {
|
|
"type": "object",
|
|
"properties": {
|
|
"assistantMessagesVariableId": {
|
|
"type": "string"
|
|
},
|
|
"userMessagesVariableId": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"role"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"role": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Dialogue"
|
|
]
|
|
},
|
|
"dialogueVariableId": {
|
|
"type": "string"
|
|
},
|
|
"startsBy": {
|
|
"type": "string",
|
|
"enum": [
|
|
"user",
|
|
"assistant"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"role"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"advancedSettings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"temperature": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"responseMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"valueToExtract": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Message content",
|
|
"Total tokens"
|
|
]
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"valueToExtract"
|
|
]
|
|
}
|
|
},
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"baseUrl": {
|
|
"type": "string"
|
|
},
|
|
"apiVersion": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"task"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"task": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Create image"
|
|
]
|
|
},
|
|
"prompt": {
|
|
"type": "string"
|
|
},
|
|
"advancedOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"size": {
|
|
"type": "string",
|
|
"enum": [
|
|
"256x256",
|
|
"512x512",
|
|
"1024x1024"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"responseMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"valueToExtract": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Image URL"
|
|
]
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"valueToExtract"
|
|
]
|
|
}
|
|
},
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"baseUrl": {
|
|
"type": "string"
|
|
},
|
|
"apiVersion": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"task",
|
|
"advancedOptions",
|
|
"responseMapping"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"baseUrl": {
|
|
"type": "string"
|
|
},
|
|
"apiVersion": {
|
|
"type": "string"
|
|
},
|
|
"task": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Create speech"
|
|
]
|
|
},
|
|
"model": {
|
|
"type": "string"
|
|
},
|
|
"input": {
|
|
"type": "string"
|
|
},
|
|
"voice": {
|
|
"type": "string",
|
|
"enum": [
|
|
"alloy",
|
|
"echo",
|
|
"fable",
|
|
"onyx",
|
|
"nova",
|
|
"shimmer"
|
|
]
|
|
},
|
|
"saveUrlInVariableId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"task"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"responseVariableMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"bodyPath": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"headers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"method": {
|
|
"type": "string",
|
|
"enum": [
|
|
"POST",
|
|
"GET",
|
|
"PUT",
|
|
"DELETE",
|
|
"PATCH",
|
|
"HEAD",
|
|
"CONNECT",
|
|
"OPTIONS",
|
|
"TRACE"
|
|
]
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"body": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"timeout": {
|
|
"type": "number",
|
|
"minimum": 1,
|
|
"maximum": 120
|
|
}
|
|
}
|
|
},
|
|
"webhookId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Webhook"
|
|
],
|
|
"description": "Legacy name for HTTP Request block"
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"variablesForTest": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"responseVariableMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"bodyPath": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"headers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"method": {
|
|
"type": "string",
|
|
"enum": [
|
|
"POST",
|
|
"GET",
|
|
"PUT",
|
|
"DELETE",
|
|
"PATCH",
|
|
"HEAD",
|
|
"CONNECT",
|
|
"OPTIONS",
|
|
"TRACE"
|
|
]
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"body": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"timeout": {
|
|
"type": "number",
|
|
"minimum": 1,
|
|
"maximum": 120
|
|
}
|
|
}
|
|
},
|
|
"webhookId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"responseVariableMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"bodyPath": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"headers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"method": {
|
|
"type": "string",
|
|
"enum": [
|
|
"POST",
|
|
"GET",
|
|
"PUT",
|
|
"DELETE",
|
|
"PATCH",
|
|
"HEAD",
|
|
"CONNECT",
|
|
"OPTIONS",
|
|
"TRACE"
|
|
]
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"body": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"timeout": {
|
|
"type": "number",
|
|
"minimum": 1,
|
|
"maximum": 120
|
|
}
|
|
}
|
|
},
|
|
"webhookId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Pixel"
|
|
]
|
|
},
|
|
"options": {
|
|
"oneOf": [
|
|
{
|
|
"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"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"eventType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Lead",
|
|
"Contact",
|
|
"CompleteRegistration",
|
|
"Schedule",
|
|
"SubmitApplication",
|
|
"ViewContent",
|
|
"AddPaymentInfo",
|
|
"AddToCart",
|
|
"AddToWishlist",
|
|
"CustomizeProduct",
|
|
"Donate",
|
|
"FindLocation",
|
|
"InitiateCheckout",
|
|
"Purchase",
|
|
"Search",
|
|
"StartTrial",
|
|
"Subscribe"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"eventType"
|
|
]
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"eventType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Custom"
|
|
]
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"eventType"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Zemantic AI"
|
|
]
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"systemPrompt": {
|
|
"type": "string"
|
|
},
|
|
"prompt": {
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"type": "string"
|
|
},
|
|
"maxResults": {
|
|
"type": "integer"
|
|
},
|
|
"responseMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"valueToExtract": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Summary",
|
|
"Results"
|
|
]
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"valueToExtract"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"title",
|
|
"graphCoordinates",
|
|
"blocks"
|
|
]
|
|
}
|
|
},
|
|
"theme": {
|
|
"$ref": "#/components/schemas/theme"
|
|
},
|
|
"settings": {
|
|
"$ref": "#/components/schemas/settings"
|
|
},
|
|
"folderId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"variables": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"nullable": true,
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"name"
|
|
]
|
|
}
|
|
},
|
|
"edges": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"from": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"blockId": {
|
|
"type": "string"
|
|
},
|
|
"itemId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"blockId"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"eventId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"eventId"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"to": {
|
|
"type": "object",
|
|
"properties": {
|
|
"groupId": {
|
|
"type": "string"
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"groupId"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"from",
|
|
"to"
|
|
]
|
|
}
|
|
},
|
|
"resultsTablePreferences": {
|
|
"type": "object",
|
|
"nullable": true,
|
|
"properties": {
|
|
"columnsOrder": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"columnsVisibility": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"columnsWidth": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "number"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"columnsOrder",
|
|
"columnsVisibility",
|
|
"columnsWidth"
|
|
]
|
|
},
|
|
"publicId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"customDomain": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"isClosed": {
|
|
"type": "boolean"
|
|
},
|
|
"whatsAppCredentialsId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"riskLevel": {
|
|
"type": "number",
|
|
"nullable": true
|
|
},
|
|
"events": {
|
|
"type": "array"
|
|
},
|
|
"updatedAt": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "Typebot V5"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"typebot"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"typebot": {
|
|
"$ref": "#/components/schemas/typebotV6"
|
|
}
|
|
},
|
|
"required": [
|
|
"typebot"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"operationId": "typebot-getTypebot",
|
|
"summary": "Get a typebot",
|
|
"tags": [
|
|
"Typebot"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "typebotId",
|
|
"description": "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)"
|
|
},
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "migrateToLatestVersion",
|
|
"description": "If enabled, the typebot will be converted to the latest schema version",
|
|
"schema": {
|
|
"type": "boolean",
|
|
"default": false,
|
|
"description": "If enabled, the typebot will be converted to the latest schema version"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"typebot": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/typebotV6"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/typebotV5"
|
|
}
|
|
],
|
|
"discriminator": {
|
|
"propertyName": "version",
|
|
"mapping": {
|
|
"3": "#/components/schemas/typebotV5",
|
|
"4": "#/components/schemas/typebotV5",
|
|
"5": "#/components/schemas/typebotV5",
|
|
"6": "#/components/schemas/typebotV6"
|
|
}
|
|
}
|
|
},
|
|
"currentUserMode": {
|
|
"type": "string",
|
|
"enum": [
|
|
"guest",
|
|
"read",
|
|
"write"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"typebot",
|
|
"currentUserMode"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"operationId": "typebot-deleteTypebot",
|
|
"summary": "Delete a typebot",
|
|
"tags": [
|
|
"Typebot"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "typebotId",
|
|
"description": "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"message": {
|
|
"type": "string",
|
|
"enum": [
|
|
"success"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"message"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/typebots/{typebotId}/publishedTypebot": {
|
|
"get": {
|
|
"operationId": "typebot-getPublishedTypebot",
|
|
"summary": "Get published typebot",
|
|
"tags": [
|
|
"Typebot"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "typebotId",
|
|
"description": "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)"
|
|
},
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "migrateToLatestVersion",
|
|
"description": "If enabled, the typebot will be converted to the latest schema version",
|
|
"schema": {
|
|
"type": "boolean",
|
|
"default": false,
|
|
"description": "If enabled, the typebot will be converted to the latest schema version"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"publishedTypebot": {
|
|
"nullable": true,
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/publicTypebotV6"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/publicTypebotV5"
|
|
}
|
|
],
|
|
"discriminator": {
|
|
"propertyName": "version",
|
|
"mapping": {
|
|
"3": "#/components/schemas/publicTypebotV5",
|
|
"4": "#/components/schemas/publicTypebotV5",
|
|
"5": "#/components/schemas/publicTypebotV5",
|
|
"6": "#/components/schemas/publicTypebotV6"
|
|
}
|
|
}
|
|
},
|
|
"version": {
|
|
"type": "string",
|
|
"enum": [
|
|
"3",
|
|
"4",
|
|
"5",
|
|
"6"
|
|
],
|
|
"description": "Provides the version the published bot was migrated from if `migrateToLatestVersion` is set to `true`."
|
|
}
|
|
},
|
|
"required": [
|
|
"publishedTypebot"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/typebots/{typebotId}/publish": {
|
|
"post": {
|
|
"operationId": "typebot-publishTypebot",
|
|
"summary": "Publish a typebot",
|
|
"tags": [
|
|
"Typebot"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "typebotId",
|
|
"description": "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"message": {
|
|
"type": "string",
|
|
"enum": [
|
|
"success"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"message"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/typebots/{typebotId}/unpublish": {
|
|
"post": {
|
|
"operationId": "typebot-unpublishTypebot",
|
|
"summary": "Unpublish a typebot",
|
|
"tags": [
|
|
"Typebot"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "typebotId",
|
|
"description": "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"message": {
|
|
"type": "string",
|
|
"enum": [
|
|
"success"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"message"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/typebots/import": {
|
|
"post": {
|
|
"operationId": "typebot-importTypebot",
|
|
"summary": "Import a typebot",
|
|
"tags": [
|
|
"Typebot"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"workspaceId": {
|
|
"type": "string",
|
|
"description": "[Where to find my workspace ID?](../how-to#how-to-find-my-workspaceid)"
|
|
},
|
|
"typebot": {
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"version": {
|
|
"type": "string",
|
|
"enum": [
|
|
"6"
|
|
]
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"events": {
|
|
"type": "array",
|
|
"maxItems": 1,
|
|
"minItems": 1,
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/event"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"groups": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/groupV6"
|
|
}
|
|
},
|
|
"edges": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"from": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"blockId": {
|
|
"type": "string"
|
|
},
|
|
"itemId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"blockId"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"eventId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"eventId"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"to": {
|
|
"type": "object",
|
|
"properties": {
|
|
"groupId": {
|
|
"type": "string"
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"groupId"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"from",
|
|
"to"
|
|
]
|
|
}
|
|
},
|
|
"variables": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"nullable": true,
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"name"
|
|
]
|
|
}
|
|
},
|
|
"theme": {
|
|
"$ref": "#/components/schemas/theme"
|
|
},
|
|
"settings": {
|
|
"$ref": "#/components/schemas/settings"
|
|
},
|
|
"icon": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"resultsTablePreferences": {
|
|
"type": "object",
|
|
"nullable": true,
|
|
"properties": {
|
|
"columnsOrder": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"columnsVisibility": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"columnsWidth": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "number"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"columnsOrder",
|
|
"columnsVisibility",
|
|
"columnsWidth"
|
|
]
|
|
},
|
|
"selectedThemeTemplateId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"version",
|
|
"name",
|
|
"events",
|
|
"groups",
|
|
"edges",
|
|
"variables",
|
|
"theme",
|
|
"settings",
|
|
"icon"
|
|
],
|
|
"title": "Typebot V6"
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"version": {
|
|
"type": "string",
|
|
"enum": [
|
|
"3",
|
|
"4",
|
|
"5"
|
|
]
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"events": {
|
|
"type": "array"
|
|
},
|
|
"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"
|
|
]
|
|
},
|
|
"blocks": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"start"
|
|
]
|
|
},
|
|
"label": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type",
|
|
"label"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"text"
|
|
]
|
|
},
|
|
"content": {
|
|
"type": "object",
|
|
"properties": {
|
|
"html": {
|
|
"type": "string"
|
|
},
|
|
"richText": {
|
|
"type": "array",
|
|
"items": {}
|
|
},
|
|
"plainText": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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",
|
|
"tiktok",
|
|
"gumlet"
|
|
]
|
|
},
|
|
"height": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{}
|
|
]
|
|
},
|
|
"aspectRatio": {
|
|
"type": "string"
|
|
},
|
|
"maxWidth": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"embed"
|
|
]
|
|
},
|
|
"content": {
|
|
"type": "object",
|
|
"properties": {
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"height": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"audio"
|
|
]
|
|
},
|
|
"content": {
|
|
"type": "object",
|
|
"properties": {
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"isAutoplayEnabled": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/textInput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/buttonsInputV5"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/email"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/numberInput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/url"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/phoneNumberInput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/dateInput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/paymentInput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/rating"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/fileInputV5"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/pictureChoiceV5"
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Code"
|
|
]
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"shouldExecuteInParentContext": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Condition"
|
|
]
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type",
|
|
"items"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Redirect"
|
|
]
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"isNewTab": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Set variable"
|
|
]
|
|
},
|
|
"options": {
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"expressionToEvaluate": {
|
|
"type": "string"
|
|
},
|
|
"isCode": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Now",
|
|
"Yesterday",
|
|
"Tomorrow"
|
|
]
|
|
},
|
|
"timeZone": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Today",
|
|
"Moment of the day",
|
|
"Empty",
|
|
"Environment name",
|
|
"User ID",
|
|
"Result ID",
|
|
"Random ID",
|
|
"Phone number",
|
|
"Contact name"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Custom"
|
|
]
|
|
},
|
|
"expressionToEvaluate": {
|
|
"type": "string"
|
|
},
|
|
"isCode": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Map item with same index"
|
|
]
|
|
},
|
|
"mapListItemParams": {
|
|
"type": "object",
|
|
"properties": {
|
|
"baseItemVariableId": {
|
|
"type": "string"
|
|
},
|
|
"baseListVariableId": {
|
|
"type": "string"
|
|
},
|
|
"targetListVariableId": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Append value(s)"
|
|
]
|
|
},
|
|
"item": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Typebot link"
|
|
]
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"typebotId": {
|
|
"type": "string"
|
|
},
|
|
"groupId": {
|
|
"type": "string"
|
|
},
|
|
"mergeResults": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Wait"
|
|
]
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"secondsToWaitFor": {
|
|
"type": "string"
|
|
},
|
|
"shouldPause": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Jump"
|
|
]
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"groupId": {
|
|
"type": "string"
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"AB test"
|
|
]
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"maxItems": 2,
|
|
"minItems": 2,
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"path": {
|
|
"type": "string",
|
|
"enum": [
|
|
"a"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"path"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"path": {
|
|
"type": "string",
|
|
"enum": [
|
|
"b"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"path"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"aPercent": {
|
|
"type": "number",
|
|
"minimum": 0,
|
|
"maximum": 100
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type",
|
|
"items"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Google Sheets"
|
|
]
|
|
},
|
|
"options": {
|
|
"oneOf": [
|
|
{
|
|
"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"
|
|
]
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"logicalOperator": {
|
|
"type": "string",
|
|
"enum": [
|
|
"OR",
|
|
"AND"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"cellsToExtract": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"column": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"totalRowsToExtract": {
|
|
"type": "string",
|
|
"enum": [
|
|
"All",
|
|
"First",
|
|
"Last",
|
|
"Random"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"action"
|
|
]
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"action"
|
|
]
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"referenceCell": {
|
|
"type": "object",
|
|
"properties": {
|
|
"column": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"logicalOperator": {
|
|
"type": "string",
|
|
"enum": [
|
|
"OR",
|
|
"AND"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"action"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"sheetId": {
|
|
"type": "string"
|
|
},
|
|
"spreadsheetId": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"responseVariableMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"bodyPath": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"headers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"method": {
|
|
"type": "string",
|
|
"enum": [
|
|
"POST",
|
|
"GET",
|
|
"PUT",
|
|
"DELETE",
|
|
"PATCH",
|
|
"HEAD",
|
|
"CONNECT",
|
|
"OPTIONS",
|
|
"TRACE"
|
|
]
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"body": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"timeout": {
|
|
"type": "number",
|
|
"minimum": 1,
|
|
"maximum": 120
|
|
}
|
|
}
|
|
},
|
|
"webhookId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"OpenAI"
|
|
]
|
|
},
|
|
"options": {
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"baseUrl": {
|
|
"type": "string"
|
|
},
|
|
"apiVersion": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"role": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Messages sequence ✨"
|
|
]
|
|
},
|
|
"content": {
|
|
"type": "object",
|
|
"properties": {
|
|
"assistantMessagesVariableId": {
|
|
"type": "string"
|
|
},
|
|
"userMessagesVariableId": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"role"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"role": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Dialogue"
|
|
]
|
|
},
|
|
"dialogueVariableId": {
|
|
"type": "string"
|
|
},
|
|
"startsBy": {
|
|
"type": "string",
|
|
"enum": [
|
|
"user",
|
|
"assistant"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"role"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"advancedSettings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"temperature": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"responseMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"valueToExtract": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Message content",
|
|
"Total tokens"
|
|
]
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"valueToExtract"
|
|
]
|
|
}
|
|
},
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"baseUrl": {
|
|
"type": "string"
|
|
},
|
|
"apiVersion": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"task"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"task": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Create image"
|
|
]
|
|
},
|
|
"prompt": {
|
|
"type": "string"
|
|
},
|
|
"advancedOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"size": {
|
|
"type": "string",
|
|
"enum": [
|
|
"256x256",
|
|
"512x512",
|
|
"1024x1024"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"responseMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"valueToExtract": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Image URL"
|
|
]
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"valueToExtract"
|
|
]
|
|
}
|
|
},
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"baseUrl": {
|
|
"type": "string"
|
|
},
|
|
"apiVersion": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"task",
|
|
"advancedOptions",
|
|
"responseMapping"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"baseUrl": {
|
|
"type": "string"
|
|
},
|
|
"apiVersion": {
|
|
"type": "string"
|
|
},
|
|
"task": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Create speech"
|
|
]
|
|
},
|
|
"model": {
|
|
"type": "string"
|
|
},
|
|
"input": {
|
|
"type": "string"
|
|
},
|
|
"voice": {
|
|
"type": "string",
|
|
"enum": [
|
|
"alloy",
|
|
"echo",
|
|
"fable",
|
|
"onyx",
|
|
"nova",
|
|
"shimmer"
|
|
]
|
|
},
|
|
"saveUrlInVariableId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"task"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"responseVariableMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"bodyPath": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"headers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"method": {
|
|
"type": "string",
|
|
"enum": [
|
|
"POST",
|
|
"GET",
|
|
"PUT",
|
|
"DELETE",
|
|
"PATCH",
|
|
"HEAD",
|
|
"CONNECT",
|
|
"OPTIONS",
|
|
"TRACE"
|
|
]
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"body": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"timeout": {
|
|
"type": "number",
|
|
"minimum": 1,
|
|
"maximum": 120
|
|
}
|
|
}
|
|
},
|
|
"webhookId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Webhook"
|
|
],
|
|
"description": "Legacy name for HTTP Request block"
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"variablesForTest": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"responseVariableMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"bodyPath": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"headers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"method": {
|
|
"type": "string",
|
|
"enum": [
|
|
"POST",
|
|
"GET",
|
|
"PUT",
|
|
"DELETE",
|
|
"PATCH",
|
|
"HEAD",
|
|
"CONNECT",
|
|
"OPTIONS",
|
|
"TRACE"
|
|
]
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"body": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"timeout": {
|
|
"type": "number",
|
|
"minimum": 1,
|
|
"maximum": 120
|
|
}
|
|
}
|
|
},
|
|
"webhookId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"responseVariableMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"bodyPath": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"headers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"method": {
|
|
"type": "string",
|
|
"enum": [
|
|
"POST",
|
|
"GET",
|
|
"PUT",
|
|
"DELETE",
|
|
"PATCH",
|
|
"HEAD",
|
|
"CONNECT",
|
|
"OPTIONS",
|
|
"TRACE"
|
|
]
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"body": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"timeout": {
|
|
"type": "number",
|
|
"minimum": 1,
|
|
"maximum": 120
|
|
}
|
|
}
|
|
},
|
|
"webhookId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Pixel"
|
|
]
|
|
},
|
|
"options": {
|
|
"oneOf": [
|
|
{
|
|
"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"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"eventType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Lead",
|
|
"Contact",
|
|
"CompleteRegistration",
|
|
"Schedule",
|
|
"SubmitApplication",
|
|
"ViewContent",
|
|
"AddPaymentInfo",
|
|
"AddToCart",
|
|
"AddToWishlist",
|
|
"CustomizeProduct",
|
|
"Donate",
|
|
"FindLocation",
|
|
"InitiateCheckout",
|
|
"Purchase",
|
|
"Search",
|
|
"StartTrial",
|
|
"Subscribe"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"eventType"
|
|
]
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"eventType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Custom"
|
|
]
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"eventType"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Zemantic AI"
|
|
]
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"systemPrompt": {
|
|
"type": "string"
|
|
},
|
|
"prompt": {
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"type": "string"
|
|
},
|
|
"maxResults": {
|
|
"type": "integer"
|
|
},
|
|
"responseMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"valueToExtract": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Summary",
|
|
"Results"
|
|
]
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"valueToExtract"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"title",
|
|
"graphCoordinates",
|
|
"blocks"
|
|
]
|
|
}
|
|
},
|
|
"edges": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"from": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"blockId": {
|
|
"type": "string"
|
|
},
|
|
"itemId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"blockId"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"eventId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"eventId"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"to": {
|
|
"type": "object",
|
|
"properties": {
|
|
"groupId": {
|
|
"type": "string"
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"groupId"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"from",
|
|
"to"
|
|
]
|
|
}
|
|
},
|
|
"variables": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"nullable": true,
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"name"
|
|
]
|
|
}
|
|
},
|
|
"theme": {
|
|
"$ref": "#/components/schemas/theme"
|
|
},
|
|
"settings": {
|
|
"$ref": "#/components/schemas/settings"
|
|
},
|
|
"icon": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"resultsTablePreferences": {
|
|
"type": "object",
|
|
"nullable": true,
|
|
"properties": {
|
|
"columnsOrder": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"columnsVisibility": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"columnsWidth": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "number"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"columnsOrder",
|
|
"columnsVisibility",
|
|
"columnsWidth"
|
|
]
|
|
},
|
|
"selectedThemeTemplateId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"version",
|
|
"name",
|
|
"events",
|
|
"groups",
|
|
"edges",
|
|
"variables",
|
|
"theme",
|
|
"settings",
|
|
"icon"
|
|
],
|
|
"title": "Typebot V5"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"workspaceId",
|
|
"typebot"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"typebot": {
|
|
"$ref": "#/components/schemas/typebotV6"
|
|
}
|
|
},
|
|
"required": [
|
|
"typebot"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/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": [
|
|
{
|
|
"in": "path",
|
|
"name": "typebotId",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"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"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"webhookBlocks"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/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": [
|
|
{
|
|
"in": "path",
|
|
"name": "typebotId",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "blockId",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"resultExample": {
|
|
"type": "object",
|
|
"additionalProperties": {},
|
|
"description": "Can contain any fields."
|
|
}
|
|
},
|
|
"required": [
|
|
"resultExample"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/typebots/{typebotId}/webhookBlocks/{blockId}/subscribe": {
|
|
"post": {
|
|
"operationId": "webhook-subscribeWebhook",
|
|
"summary": "Subscribe to webhook block",
|
|
"tags": [
|
|
"Webhook"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "typebotId",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "blockId",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"url": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"url"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"url"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/typebots/{typebotId}/webhookBlocks/{blockId}/unsubscribe": {
|
|
"post": {
|
|
"operationId": "webhook-unsubscribeWebhook",
|
|
"summary": "Unsubscribe from webhook block",
|
|
"tags": [
|
|
"Webhook"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "typebotId",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "blockId",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"url"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/typebots/{typebotId}/results": {
|
|
"get": {
|
|
"operationId": "results-getResults",
|
|
"summary": "List results ordered by descending creation date",
|
|
"tags": [
|
|
"Results"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "typebotId",
|
|
"description": "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)"
|
|
},
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "limit",
|
|
"schema": {
|
|
"type": "number",
|
|
"minimum": 1,
|
|
"maximum": 100,
|
|
"default": 50
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cursor",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timeFilter",
|
|
"schema": {
|
|
"type": "string",
|
|
"enum": [
|
|
"today",
|
|
"last7Days",
|
|
"last30Days",
|
|
"yearToDate",
|
|
"allTime"
|
|
],
|
|
"default": "today"
|
|
}
|
|
}
|
|
],
|
|
"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"
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"isCompleted": {
|
|
"type": "boolean"
|
|
},
|
|
"hasStarted": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
},
|
|
"isArchived": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
},
|
|
"answers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"type": "string"
|
|
},
|
|
"resultId": {
|
|
"type": "string"
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
},
|
|
"groupId": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"content": {
|
|
"type": "string"
|
|
},
|
|
"storageUsed": {
|
|
"type": "number",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"createdAt",
|
|
"resultId",
|
|
"blockId",
|
|
"groupId",
|
|
"variableId",
|
|
"content",
|
|
"storageUsed"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"typebotId",
|
|
"variables",
|
|
"isCompleted",
|
|
"hasStarted",
|
|
"isArchived",
|
|
"answers"
|
|
]
|
|
}
|
|
},
|
|
"nextCursor": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"results"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"operationId": "results-deleteResults",
|
|
"summary": "Delete results",
|
|
"tags": [
|
|
"Results"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "typebotId",
|
|
"description": "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)"
|
|
},
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "resultIds",
|
|
"description": "Comma separated list of ids. If not provided, all results will be deleted. ⚠️",
|
|
"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": {}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/typebots/{typebotId}/results/{resultId}": {
|
|
"get": {
|
|
"operationId": "results-getResult",
|
|
"summary": "Get result by id",
|
|
"tags": [
|
|
"Results"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "typebotId",
|
|
"description": "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)"
|
|
},
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "resultId",
|
|
"description": "The `resultId` is returned by the /startChat endpoint or you can find it by listing results with `/results` endpoint",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "The `resultId` is returned by the /startChat endpoint or you can find it by listing results with `/results` endpoint"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"result": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"createdAt": {
|
|
"type": "string"
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"isCompleted": {
|
|
"type": "boolean"
|
|
},
|
|
"hasStarted": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
},
|
|
"isArchived": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
},
|
|
"answers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"type": "string"
|
|
},
|
|
"resultId": {
|
|
"type": "string"
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
},
|
|
"groupId": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"content": {
|
|
"type": "string"
|
|
},
|
|
"storageUsed": {
|
|
"type": "number",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"createdAt",
|
|
"resultId",
|
|
"blockId",
|
|
"groupId",
|
|
"variableId",
|
|
"content",
|
|
"storageUsed"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"typebotId",
|
|
"variables",
|
|
"isCompleted",
|
|
"hasStarted",
|
|
"isArchived",
|
|
"answers"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"result"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/typebots/{typebotId}/results/{resultId}/logs": {
|
|
"get": {
|
|
"operationId": "results-getResultLogs",
|
|
"summary": "List result logs",
|
|
"tags": [
|
|
"Results"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "typebotId",
|
|
"description": "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)"
|
|
},
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "resultId",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"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"
|
|
},
|
|
"resultId": {
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"details": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"resultId",
|
|
"status",
|
|
"description",
|
|
"details"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"logs"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/billing/subscription/portal": {
|
|
"get": {
|
|
"operationId": "billing-getBillingPortalUrl",
|
|
"summary": "Get Stripe billing portal URL",
|
|
"tags": [
|
|
"Billing"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "query",
|
|
"name": "workspaceId",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"billingPortalUrl": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"billingPortalUrl"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/billing/invoices": {
|
|
"get": {
|
|
"operationId": "billing-listInvoices",
|
|
"summary": "List invoices",
|
|
"tags": [
|
|
"Billing"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "query",
|
|
"name": "workspaceId",
|
|
"description": "[Where to find my workspace ID?](../how-to#how-to-find-my-workspaceid)",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "[Where to find my workspace ID?](../how-to#how-to-find-my-workspaceid)"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"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"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"invoices"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/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"
|
|
},
|
|
"vat": {
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"value"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"email",
|
|
"company",
|
|
"workspaceId",
|
|
"currency",
|
|
"plan",
|
|
"returnUrl"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"checkoutUrl": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"checkoutUrl"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/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"
|
|
]
|
|
},
|
|
"currency": {
|
|
"type": "string",
|
|
"enum": [
|
|
"usd",
|
|
"eur"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"returnUrl",
|
|
"workspaceId",
|
|
"plan",
|
|
"currency"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"workspace": {
|
|
"type": "object",
|
|
"nullable": true,
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"createdAt": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"type": "string"
|
|
},
|
|
"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",
|
|
"nullable": true
|
|
},
|
|
"chatsLimitSecondEmailSentAt": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"storageLimitFirstEmailSentAt": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"storageLimitSecondEmailSentAt": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"customChatsLimit": {
|
|
"type": "number",
|
|
"nullable": true
|
|
},
|
|
"customStorageLimit": {
|
|
"type": "number",
|
|
"nullable": true
|
|
},
|
|
"customSeatsLimit": {
|
|
"type": "number",
|
|
"nullable": true
|
|
},
|
|
"isQuarantined": {
|
|
"type": "boolean"
|
|
},
|
|
"isSuspended": {
|
|
"type": "boolean"
|
|
},
|
|
"isPastDue": {
|
|
"type": "boolean"
|
|
},
|
|
"isVerified": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"icon",
|
|
"plan",
|
|
"stripeId",
|
|
"additionalChatsIndex",
|
|
"additionalStorageIndex",
|
|
"chatsLimitFirstEmailSentAt",
|
|
"chatsLimitSecondEmailSentAt",
|
|
"storageLimitFirstEmailSentAt",
|
|
"storageLimitSecondEmailSentAt",
|
|
"customChatsLimit",
|
|
"customStorageLimit",
|
|
"customSeatsLimit",
|
|
"isQuarantined",
|
|
"isSuspended",
|
|
"isPastDue",
|
|
"isVerified"
|
|
]
|
|
},
|
|
"checkoutUrl": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"operationId": "billing-getSubscription",
|
|
"summary": "List invoices",
|
|
"tags": [
|
|
"Billing"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "query",
|
|
"name": "workspaceId",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"subscription": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"currentBillingPeriod": {
|
|
"type": "object",
|
|
"properties": {
|
|
"start": {
|
|
"type": "string"
|
|
},
|
|
"end": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"start",
|
|
"end"
|
|
]
|
|
},
|
|
"currency": {
|
|
"type": "string",
|
|
"enum": [
|
|
"eur",
|
|
"usd"
|
|
]
|
|
},
|
|
"cancelDate": {
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"enum": [
|
|
"active",
|
|
"past_due"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"currentBillingPeriod",
|
|
"currency",
|
|
"status"
|
|
]
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"subscription"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/billing/usage": {
|
|
"get": {
|
|
"operationId": "billing-getUsage",
|
|
"summary": "Get current plan usage",
|
|
"tags": [
|
|
"Billing"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "query",
|
|
"name": "workspaceId",
|
|
"description": "[Where to find my workspace ID?](../how-to#how-to-find-my-workspaceid)",
|
|
"schema": {
|
|
"type": "string",
|
|
"description": "[Where to find my workspace ID?](../how-to#how-to-find-my-workspaceid)"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"totalChatsUsed": {
|
|
"type": "number"
|
|
},
|
|
"resetsAt": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"totalChatsUsed",
|
|
"resetsAt"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/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"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"checkoutUrl": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"checkoutUrl"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/credentials": {
|
|
"post": {
|
|
"operationId": "credentials-createCredentials",
|
|
"summary": "Create credentials",
|
|
"tags": [
|
|
"Credentials"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"credentials": {
|
|
"allOf": [
|
|
{
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"properties": {
|
|
"live": {
|
|
"type": "object",
|
|
"properties": {
|
|
"secretKey": {
|
|
"type": "string"
|
|
},
|
|
"publicKey": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"secretKey",
|
|
"publicKey"
|
|
]
|
|
},
|
|
"test": {
|
|
"type": "object",
|
|
"properties": {
|
|
"secretKey": {
|
|
"type": "string"
|
|
},
|
|
"publicKey": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"live",
|
|
"test"
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"stripe"
|
|
]
|
|
},
|
|
"workspaceId": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"type",
|
|
"workspaceId",
|
|
"name"
|
|
]
|
|
},
|
|
{
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"port",
|
|
"from"
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"smtp"
|
|
]
|
|
},
|
|
"workspaceId": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"type",
|
|
"workspaceId",
|
|
"name"
|
|
]
|
|
},
|
|
{
|
|
"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"
|
|
}
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"google sheets"
|
|
]
|
|
},
|
|
"workspaceId": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"type",
|
|
"workspaceId",
|
|
"name"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"properties": {
|
|
"apiKey": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"apiKey"
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"openai"
|
|
]
|
|
},
|
|
"workspaceId": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"type",
|
|
"workspaceId",
|
|
"name"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"properties": {
|
|
"systemUserAccessToken": {
|
|
"type": "string"
|
|
},
|
|
"phoneNumberId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"systemUserAccessToken",
|
|
"phoneNumberId"
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"whatsApp"
|
|
]
|
|
},
|
|
"workspaceId": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"type",
|
|
"workspaceId",
|
|
"name"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "object",
|
|
"properties": {
|
|
"apiKey": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"apiKey"
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"zemanticAi"
|
|
]
|
|
},
|
|
"workspaceId": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"type",
|
|
"workspaceId",
|
|
"name"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"credentials"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"credentialsId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"credentialsId"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"operationId": "credentials-listCredentials",
|
|
"summary": "List workspace credentials",
|
|
"tags": [
|
|
"Credentials"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "query",
|
|
"name": "workspaceId",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "type",
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"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"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"zemanticAi"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"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"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"credentials"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/credentials/:credentialsId": {
|
|
"delete": {
|
|
"operationId": "credentials-deleteCredentials",
|
|
"summary": "Delete credentials",
|
|
"tags": [
|
|
"Credentials"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "query",
|
|
"name": "credentialsId",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "workspaceId",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"credentialsId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"credentialsId"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/themeTemplates": {
|
|
"get": {
|
|
"operationId": "theme-listThemeTemplates",
|
|
"summary": "List theme templates",
|
|
"tags": [
|
|
"Theme template"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "query",
|
|
"name": "workspaceId",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"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": {
|
|
"$ref": "#/components/schemas/theme"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"name",
|
|
"theme"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"themeTemplates"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/themeTemplates/{themeTemplateId}": {
|
|
"put": {
|
|
"operationId": "theme-saveThemeTemplate",
|
|
"summary": "Save theme template",
|
|
"tags": [
|
|
"Theme template"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "themeTemplateId",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"workspaceId": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"theme": {
|
|
"$ref": "#/components/schemas/theme"
|
|
}
|
|
},
|
|
"required": [
|
|
"workspaceId",
|
|
"name",
|
|
"theme"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"themeTemplate": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"theme": {
|
|
"$ref": "#/components/schemas/theme"
|
|
},
|
|
"workspaceId": {
|
|
"type": "string"
|
|
},
|
|
"createdAt": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"name",
|
|
"theme",
|
|
"workspaceId",
|
|
"createdAt",
|
|
"updatedAt"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"themeTemplate"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"operationId": "theme-deleteThemeTemplate",
|
|
"summary": "Delete a theme template",
|
|
"tags": [
|
|
"Theme template"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "themeTemplateId",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "workspaceId",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"themeTemplate": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"theme": {
|
|
"$ref": "#/components/schemas/theme"
|
|
},
|
|
"workspaceId": {
|
|
"type": "string"
|
|
},
|
|
"createdAt": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"name",
|
|
"theme",
|
|
"workspaceId",
|
|
"createdAt",
|
|
"updatedAt"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"themeTemplate"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/typebots/{typebotId}/collaborators": {
|
|
"get": {
|
|
"operationId": "collaborators-getCollaborators",
|
|
"summary": "Get collaborators",
|
|
"tags": [
|
|
"Collaborators"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "typebotId",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"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"
|
|
},
|
|
"updatedAt": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"userId",
|
|
"typebotId",
|
|
"createdAt",
|
|
"updatedAt"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"collaborators"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/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"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"customDomain": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"createdAt": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"createdAt"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"customDomain"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"operationId": "customDomains-listCustomDomains",
|
|
"summary": "List custom domains",
|
|
"tags": [
|
|
"Custom domains"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "query",
|
|
"name": "workspaceId",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"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"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"createdAt"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"customDomains"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/custom-domains/{name}": {
|
|
"delete": {
|
|
"operationId": "customDomains-deleteCustomDomain",
|
|
"summary": "Delete custom domain",
|
|
"tags": [
|
|
"Custom domains"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "name",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "workspaceId",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"message": {
|
|
"type": "string",
|
|
"enum": [
|
|
"success"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"message"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/custom-domains/{name}/verify": {
|
|
"get": {
|
|
"operationId": "customDomains-verifyCustomDomain",
|
|
"summary": "Verify domain config",
|
|
"tags": [
|
|
"Custom domains"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "name",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "workspaceId",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"status": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Valid Configuration",
|
|
"Invalid Configuration",
|
|
"Domain Not Found",
|
|
"Pending Verification",
|
|
"Unknown Error"
|
|
]
|
|
},
|
|
"domainJson": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"apexName": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"redirect": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"redirectStatusCode": {
|
|
"type": "number",
|
|
"nullable": true
|
|
},
|
|
"gitBranch": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"updatedAt": {
|
|
"type": "number",
|
|
"nullable": true
|
|
},
|
|
"createdAt": {
|
|
"type": "number",
|
|
"nullable": true
|
|
},
|
|
"verified": {
|
|
"type": "boolean"
|
|
},
|
|
"verification": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"domain": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
},
|
|
"reason": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"domain",
|
|
"value",
|
|
"reason"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"apexName",
|
|
"projectId",
|
|
"redirect",
|
|
"redirectStatusCode",
|
|
"gitBranch",
|
|
"updatedAt",
|
|
"createdAt",
|
|
"verified"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"status",
|
|
"domainJson"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/typebots/{typebotId}/whatsapp/start-preview": {
|
|
"post": {
|
|
"operationId": "whatsApp-startWhatsAppPreview",
|
|
"summary": "Start preview",
|
|
"tags": [
|
|
"WhatsApp"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "typebotId",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"to": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
"startFrom": {
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"group"
|
|
]
|
|
},
|
|
"groupId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"groupId"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"event"
|
|
]
|
|
},
|
|
"eventId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"eventId"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"to"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"message": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"message"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/whatsapp/preview/webhook": {
|
|
"get": {
|
|
"operationId": "whatsApp-subscribePreviewWebhook",
|
|
"summary": "Subscribe webhook",
|
|
"tags": [
|
|
"WhatsApp"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "query",
|
|
"name": "hub.challenge",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hub.verify_token",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"operationId": "whatsApp-receiveMessagePreview",
|
|
"summary": "Message webhook",
|
|
"tags": [
|
|
"WhatsApp"
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"entry": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"changes": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"value": {
|
|
"type": "object",
|
|
"properties": {
|
|
"metadata": {
|
|
"type": "object",
|
|
"properties": {
|
|
"phone_number_id": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"phone_number_id"
|
|
]
|
|
},
|
|
"contacts": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"profile": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"profile"
|
|
]
|
|
}
|
|
},
|
|
"messages": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"from": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"text"
|
|
]
|
|
},
|
|
"text": {
|
|
"type": "object",
|
|
"properties": {
|
|
"body": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"body"
|
|
]
|
|
},
|
|
"timestamp": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"from",
|
|
"type",
|
|
"text",
|
|
"timestamp"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"from": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"button"
|
|
]
|
|
},
|
|
"button": {
|
|
"type": "object",
|
|
"properties": {
|
|
"text": {
|
|
"type": "string"
|
|
},
|
|
"payload": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"text",
|
|
"payload"
|
|
]
|
|
},
|
|
"timestamp": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"from",
|
|
"type",
|
|
"button",
|
|
"timestamp"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"from": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"interactive"
|
|
]
|
|
},
|
|
"interactive": {
|
|
"type": "object",
|
|
"properties": {
|
|
"button_reply": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"title"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"button_reply"
|
|
]
|
|
},
|
|
"timestamp": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"from",
|
|
"type",
|
|
"interactive",
|
|
"timestamp"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"from": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"image"
|
|
]
|
|
},
|
|
"image": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"timestamp": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"from",
|
|
"type",
|
|
"image",
|
|
"timestamp"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"from": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"video"
|
|
]
|
|
},
|
|
"video": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"timestamp": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"from",
|
|
"type",
|
|
"video",
|
|
"timestamp"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"from": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"audio"
|
|
]
|
|
},
|
|
"audio": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"timestamp": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"from",
|
|
"type",
|
|
"audio",
|
|
"timestamp"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"from": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"document"
|
|
]
|
|
},
|
|
"document": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"timestamp": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"from",
|
|
"type",
|
|
"document",
|
|
"timestamp"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"from": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"location"
|
|
]
|
|
},
|
|
"location": {
|
|
"type": "object",
|
|
"properties": {
|
|
"latitude": {
|
|
"type": "number"
|
|
},
|
|
"longitude": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"latitude",
|
|
"longitude"
|
|
]
|
|
},
|
|
"timestamp": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"from",
|
|
"type",
|
|
"location",
|
|
"timestamp"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"metadata"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"value"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"changes"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"entry"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"message": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"message"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/folders/{folderId}": {
|
|
"get": {
|
|
"operationId": "folders-getFolder",
|
|
"summary": "Get folder",
|
|
"tags": [
|
|
"Folder"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "folderId",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "workspaceId",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"folder": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"createdAt": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parentFolderId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"workspaceId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"parentFolderId",
|
|
"workspaceId"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"folder"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"operationId": "folders-updateFolder",
|
|
"summary": "Update a folder",
|
|
"tags": [
|
|
"Folder"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "folderId",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"workspaceId": {
|
|
"type": "string"
|
|
},
|
|
"folder": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parentFolderId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"workspaceId",
|
|
"folder"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"folder": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"createdAt": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parentFolderId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"workspaceId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"parentFolderId",
|
|
"workspaceId"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"folder"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"operationId": "folders-deleteFolder",
|
|
"summary": "Delete a folder",
|
|
"tags": [
|
|
"Folder"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "folderId",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "workspaceId",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"folder": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"createdAt": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parentFolderId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"workspaceId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"parentFolderId",
|
|
"workspaceId"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"folder"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/folders": {
|
|
"post": {
|
|
"operationId": "folders-createFolder",
|
|
"summary": "Create a folder",
|
|
"tags": [
|
|
"Folder"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"workspaceId": {
|
|
"type": "string"
|
|
},
|
|
"folderName": {
|
|
"type": "string",
|
|
"default": "New folder"
|
|
},
|
|
"parentFolderId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"workspaceId"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"folder": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"createdAt": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parentFolderId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"workspaceId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"parentFolderId",
|
|
"workspaceId"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"folder"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"operationId": "folders-listFolders",
|
|
"summary": "List folders",
|
|
"tags": [
|
|
"Folder"
|
|
],
|
|
"security": [
|
|
{
|
|
"Authorization": []
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"in": "query",
|
|
"name": "workspaceId",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"required": true
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "parentFolderId",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"folders": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"createdAt": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parentFolderId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"workspaceId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"parentFolderId",
|
|
"workspaceId"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"folders"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid input data",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.BAD_REQUEST"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Authorization not provided",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.UNAUTHORIZED"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Insufficient access",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.FORBIDDEN"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.NOT_FOUND"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal server error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"components": {
|
|
"securitySchemes": {
|
|
"Authorization": {
|
|
"type": "http",
|
|
"scheme": "bearer"
|
|
}
|
|
},
|
|
"schemas": {
|
|
"textInput": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
}
|
|
}
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isLong": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
],
|
|
"title": "Text"
|
|
},
|
|
"buttonsInputV5": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"choice input"
|
|
]
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isMultipleChoice": {
|
|
"type": "boolean"
|
|
},
|
|
"buttonLabel": {
|
|
"type": "string"
|
|
},
|
|
"dynamicVariableId": {
|
|
"type": "string"
|
|
},
|
|
"isSearchable": {
|
|
"type": "boolean"
|
|
},
|
|
"searchInputPlaceholder": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type",
|
|
"items"
|
|
],
|
|
"title": "Buttons v5"
|
|
},
|
|
"email": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
}
|
|
}
|
|
},
|
|
"retryMessageContent": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
],
|
|
"title": "Email"
|
|
},
|
|
"numberInput": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
}
|
|
}
|
|
},
|
|
"min": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{}
|
|
]
|
|
},
|
|
"max": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{}
|
|
]
|
|
},
|
|
"step": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
],
|
|
"title": "Number"
|
|
},
|
|
"url": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
}
|
|
}
|
|
},
|
|
"retryMessageContent": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
],
|
|
"title": "URL"
|
|
},
|
|
"phoneNumberInput": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
}
|
|
}
|
|
},
|
|
"retryMessageContent": {
|
|
"type": "string"
|
|
},
|
|
"defaultCountryCode": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
],
|
|
"title": "Phone number"
|
|
},
|
|
"dateInput": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
}
|
|
}
|
|
},
|
|
"hasTime": {
|
|
"type": "boolean"
|
|
},
|
|
"isRange": {
|
|
"type": "boolean"
|
|
},
|
|
"format": {
|
|
"type": "string"
|
|
},
|
|
"min": {
|
|
"type": "string"
|
|
},
|
|
"max": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
],
|
|
"title": "Date"
|
|
},
|
|
"paymentInput": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
}
|
|
}
|
|
},
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"currency": {
|
|
"type": "string"
|
|
},
|
|
"amount": {
|
|
"type": "string"
|
|
},
|
|
"retryMessageContent": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
],
|
|
"title": "Payment"
|
|
},
|
|
"rating": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
},
|
|
"startsAt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{}
|
|
]
|
|
},
|
|
"labels": {
|
|
"type": "object",
|
|
"properties": {
|
|
"left": {
|
|
"type": "string"
|
|
},
|
|
"right": {
|
|
"type": "string"
|
|
},
|
|
"button": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"customIcon": {
|
|
"type": "object",
|
|
"properties": {
|
|
"isEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"svg": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"isOneClickSubmitEnabled": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
],
|
|
"title": "Rating"
|
|
},
|
|
"fileInputV5": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
},
|
|
"success": {
|
|
"type": "object",
|
|
"properties": {
|
|
"single": {
|
|
"type": "string"
|
|
},
|
|
"multiple": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"sizeLimit": {
|
|
"type": "number"
|
|
},
|
|
"visibility": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Auto",
|
|
"Public",
|
|
"Private"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
],
|
|
"title": "File input v5"
|
|
},
|
|
"pictureChoiceV5": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type",
|
|
"items"
|
|
],
|
|
"title": "Picture choice v5"
|
|
},
|
|
"groupV6": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"type": "string"
|
|
},
|
|
"graphCoordinates": {
|
|
"type": "object",
|
|
"properties": {
|
|
"x": {
|
|
"type": "number"
|
|
},
|
|
"y": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"x",
|
|
"y"
|
|
]
|
|
},
|
|
"blocks": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/block"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"title",
|
|
"graphCoordinates",
|
|
"blocks"
|
|
],
|
|
"title": "Group V6"
|
|
},
|
|
"block": {
|
|
"anyOf": [
|
|
{
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"text"
|
|
]
|
|
},
|
|
"content": {
|
|
"type": "object",
|
|
"properties": {
|
|
"html": {
|
|
"type": "string"
|
|
},
|
|
"richText": {
|
|
"type": "array",
|
|
"items": {}
|
|
},
|
|
"plainText": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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",
|
|
"tiktok",
|
|
"gumlet"
|
|
]
|
|
},
|
|
"height": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{}
|
|
]
|
|
},
|
|
"aspectRatio": {
|
|
"type": "string"
|
|
},
|
|
"maxWidth": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"embed"
|
|
]
|
|
},
|
|
"content": {
|
|
"type": "object",
|
|
"properties": {
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"height": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"audio"
|
|
]
|
|
},
|
|
"content": {
|
|
"type": "object",
|
|
"properties": {
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"isAutoplayEnabled": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/textInput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/buttonsInput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/email"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/numberInput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/url"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/phoneNumberInput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/dateInput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/paymentInput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/rating"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/fileInput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/pictureChoice"
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Code"
|
|
]
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"shouldExecuteInParentContext": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Condition"
|
|
]
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type",
|
|
"items"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Redirect"
|
|
]
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"isNewTab": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Set variable"
|
|
]
|
|
},
|
|
"options": {
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"expressionToEvaluate": {
|
|
"type": "string"
|
|
},
|
|
"isCode": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Now",
|
|
"Yesterday",
|
|
"Tomorrow"
|
|
]
|
|
},
|
|
"timeZone": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Today",
|
|
"Moment of the day",
|
|
"Empty",
|
|
"Environment name",
|
|
"User ID",
|
|
"Result ID",
|
|
"Random ID",
|
|
"Phone number",
|
|
"Contact name"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Custom"
|
|
]
|
|
},
|
|
"expressionToEvaluate": {
|
|
"type": "string"
|
|
},
|
|
"isCode": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Map item with same index"
|
|
]
|
|
},
|
|
"mapListItemParams": {
|
|
"type": "object",
|
|
"properties": {
|
|
"baseItemVariableId": {
|
|
"type": "string"
|
|
},
|
|
"baseListVariableId": {
|
|
"type": "string"
|
|
},
|
|
"targetListVariableId": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Append value(s)"
|
|
]
|
|
},
|
|
"item": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Typebot link"
|
|
]
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"typebotId": {
|
|
"type": "string"
|
|
},
|
|
"groupId": {
|
|
"type": "string"
|
|
},
|
|
"mergeResults": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Wait"
|
|
]
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"secondsToWaitFor": {
|
|
"type": "string"
|
|
},
|
|
"shouldPause": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Jump"
|
|
]
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"groupId": {
|
|
"type": "string"
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"AB test"
|
|
]
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"maxItems": 2,
|
|
"minItems": 2,
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"path": {
|
|
"type": "string",
|
|
"enum": [
|
|
"a"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"path"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"path": {
|
|
"type": "string",
|
|
"enum": [
|
|
"b"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"path"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"aPercent": {
|
|
"type": "number",
|
|
"minimum": 0,
|
|
"maximum": 100
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type",
|
|
"items"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Google Sheets"
|
|
]
|
|
},
|
|
"options": {
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"sheetId": {
|
|
"type": "string"
|
|
},
|
|
"spreadsheetId": {
|
|
"type": "string"
|
|
},
|
|
"action": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Get data from sheet"
|
|
]
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"logicalOperator": {
|
|
"type": "string",
|
|
"enum": [
|
|
"OR",
|
|
"AND"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"cellsToExtract": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"column": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"totalRowsToExtract": {
|
|
"type": "string",
|
|
"enum": [
|
|
"All",
|
|
"First",
|
|
"Last",
|
|
"Random"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"action"
|
|
]
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"action"
|
|
]
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"logicalOperator": {
|
|
"type": "string",
|
|
"enum": [
|
|
"OR",
|
|
"AND"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"action"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"sheetId": {
|
|
"type": "string"
|
|
},
|
|
"spreadsheetId": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"responseVariableMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"bodyPath": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"isAdvancedConfig": {
|
|
"type": "boolean"
|
|
},
|
|
"isCustomBody": {
|
|
"type": "boolean"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"webhook": {
|
|
"type": "object",
|
|
"properties": {
|
|
"queryParams": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"headers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"method": {
|
|
"type": "string",
|
|
"enum": [
|
|
"POST",
|
|
"GET",
|
|
"PUT",
|
|
"DELETE",
|
|
"PATCH",
|
|
"HEAD",
|
|
"CONNECT",
|
|
"OPTIONS",
|
|
"TRACE"
|
|
]
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"body": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"timeout": {
|
|
"type": "number",
|
|
"minimum": 1,
|
|
"maximum": 120
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"OpenAI"
|
|
]
|
|
},
|
|
"options": {
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"baseUrl": {
|
|
"type": "string"
|
|
},
|
|
"apiVersion": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"role": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Messages sequence ✨"
|
|
]
|
|
},
|
|
"content": {
|
|
"type": "object",
|
|
"properties": {
|
|
"assistantMessagesVariableId": {
|
|
"type": "string"
|
|
},
|
|
"userMessagesVariableId": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"role"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"role": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Dialogue"
|
|
]
|
|
},
|
|
"dialogueVariableId": {
|
|
"type": "string"
|
|
},
|
|
"startsBy": {
|
|
"type": "string",
|
|
"enum": [
|
|
"user",
|
|
"assistant"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"role"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"advancedSettings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"temperature": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"responseMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"valueToExtract": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Message content",
|
|
"Total tokens"
|
|
]
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"valueToExtract"
|
|
]
|
|
}
|
|
},
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"baseUrl": {
|
|
"type": "string"
|
|
},
|
|
"apiVersion": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"task"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"task": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Create image"
|
|
]
|
|
},
|
|
"prompt": {
|
|
"type": "string"
|
|
},
|
|
"advancedOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"size": {
|
|
"type": "string",
|
|
"enum": [
|
|
"256x256",
|
|
"512x512",
|
|
"1024x1024"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"responseMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"valueToExtract": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Image URL"
|
|
]
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"valueToExtract"
|
|
]
|
|
}
|
|
},
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"baseUrl": {
|
|
"type": "string"
|
|
},
|
|
"apiVersion": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"task",
|
|
"advancedOptions",
|
|
"responseMapping"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"baseUrl": {
|
|
"type": "string"
|
|
},
|
|
"apiVersion": {
|
|
"type": "string"
|
|
},
|
|
"task": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Create speech"
|
|
]
|
|
},
|
|
"model": {
|
|
"type": "string"
|
|
},
|
|
"input": {
|
|
"type": "string"
|
|
},
|
|
"voice": {
|
|
"type": "string",
|
|
"enum": [
|
|
"alloy",
|
|
"echo",
|
|
"fable",
|
|
"onyx",
|
|
"nova",
|
|
"shimmer"
|
|
]
|
|
},
|
|
"saveUrlInVariableId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"task"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"responseVariableMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"bodyPath": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"isAdvancedConfig": {
|
|
"type": "boolean"
|
|
},
|
|
"isCustomBody": {
|
|
"type": "boolean"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"webhook": {
|
|
"type": "object",
|
|
"properties": {
|
|
"queryParams": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"headers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"method": {
|
|
"type": "string",
|
|
"enum": [
|
|
"POST",
|
|
"GET",
|
|
"PUT",
|
|
"DELETE",
|
|
"PATCH",
|
|
"HEAD",
|
|
"CONNECT",
|
|
"OPTIONS",
|
|
"TRACE"
|
|
]
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"body": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"timeout": {
|
|
"type": "number",
|
|
"minimum": 1,
|
|
"maximum": 120
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Webhook"
|
|
],
|
|
"description": "Legacy name for HTTP Request block"
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"variablesForTest": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"responseVariableMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"bodyPath": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"isAdvancedConfig": {
|
|
"type": "boolean"
|
|
},
|
|
"isCustomBody": {
|
|
"type": "boolean"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"webhook": {
|
|
"type": "object",
|
|
"properties": {
|
|
"queryParams": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"headers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"method": {
|
|
"type": "string",
|
|
"enum": [
|
|
"POST",
|
|
"GET",
|
|
"PUT",
|
|
"DELETE",
|
|
"PATCH",
|
|
"HEAD",
|
|
"CONNECT",
|
|
"OPTIONS",
|
|
"TRACE"
|
|
]
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"body": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"timeout": {
|
|
"type": "number",
|
|
"minimum": 1,
|
|
"maximum": 120
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"responseVariableMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"bodyPath": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"isAdvancedConfig": {
|
|
"type": "boolean"
|
|
},
|
|
"isCustomBody": {
|
|
"type": "boolean"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"webhook": {
|
|
"type": "object",
|
|
"properties": {
|
|
"queryParams": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"headers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"method": {
|
|
"type": "string",
|
|
"enum": [
|
|
"POST",
|
|
"GET",
|
|
"PUT",
|
|
"DELETE",
|
|
"PATCH",
|
|
"HEAD",
|
|
"CONNECT",
|
|
"OPTIONS",
|
|
"TRACE"
|
|
]
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"body": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"timeout": {
|
|
"type": "number",
|
|
"minimum": 1,
|
|
"maximum": 120
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Pixel"
|
|
]
|
|
},
|
|
"options": {
|
|
"oneOf": [
|
|
{
|
|
"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"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"eventType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Lead",
|
|
"Contact",
|
|
"CompleteRegistration",
|
|
"Schedule",
|
|
"SubmitApplication",
|
|
"ViewContent",
|
|
"AddPaymentInfo",
|
|
"AddToCart",
|
|
"AddToWishlist",
|
|
"CustomizeProduct",
|
|
"Donate",
|
|
"FindLocation",
|
|
"InitiateCheckout",
|
|
"Purchase",
|
|
"Search",
|
|
"StartTrial",
|
|
"Subscribe"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"eventType"
|
|
]
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"eventType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Custom"
|
|
]
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"eventType"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Zemantic AI"
|
|
]
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"systemPrompt": {
|
|
"type": "string"
|
|
},
|
|
"prompt": {
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"type": "string"
|
|
},
|
|
"maxResults": {
|
|
"type": "integer"
|
|
},
|
|
"responseMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"valueToExtract": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Summary",
|
|
"Results"
|
|
]
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"valueToExtract"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"openai",
|
|
"zemantic-ai",
|
|
"cal-com",
|
|
"chat-node",
|
|
"qr-code",
|
|
"dify-ai",
|
|
"mistral",
|
|
"elevenlabs"
|
|
]
|
|
},
|
|
"options": {}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
}
|
|
],
|
|
"title": "Block"
|
|
},
|
|
"buttonsInput": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"choice input"
|
|
]
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isMultipleChoice": {
|
|
"type": "boolean"
|
|
},
|
|
"buttonLabel": {
|
|
"type": "string"
|
|
},
|
|
"dynamicVariableId": {
|
|
"type": "string"
|
|
},
|
|
"isSearchable": {
|
|
"type": "boolean"
|
|
},
|
|
"searchInputPlaceholder": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type",
|
|
"items"
|
|
],
|
|
"title": "Buttons"
|
|
},
|
|
"fileInput": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
},
|
|
"success": {
|
|
"type": "object",
|
|
"properties": {
|
|
"single": {
|
|
"type": "string"
|
|
},
|
|
"multiple": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"visibility": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Auto",
|
|
"Public",
|
|
"Private"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
],
|
|
"title": "File"
|
|
},
|
|
"pictureChoice": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"picture choice input"
|
|
]
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type",
|
|
"items"
|
|
],
|
|
"title": "Picture choice"
|
|
},
|
|
"error.BAD_REQUEST": {
|
|
"type": "object",
|
|
"properties": {
|
|
"message": {
|
|
"type": "string",
|
|
"description": "The error message",
|
|
"example": "Invalid input data"
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"description": "The error code",
|
|
"example": "BAD_REQUEST"
|
|
},
|
|
"issues": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"message": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"message"
|
|
]
|
|
},
|
|
"description": "An array of issues that were responsible for the error",
|
|
"example": []
|
|
}
|
|
},
|
|
"required": [
|
|
"message",
|
|
"code"
|
|
],
|
|
"title": "Error",
|
|
"description": "The error information",
|
|
"example": {
|
|
"code": "BAD_REQUEST",
|
|
"message": "Invalid input data",
|
|
"issues": []
|
|
}
|
|
},
|
|
"error.UNAUTHORIZED": {
|
|
"type": "object",
|
|
"properties": {
|
|
"message": {
|
|
"type": "string",
|
|
"description": "The error message",
|
|
"example": "Authorization not provided"
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"description": "The error code",
|
|
"example": "UNAUTHORIZED"
|
|
},
|
|
"issues": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"message": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"message"
|
|
]
|
|
},
|
|
"description": "An array of issues that were responsible for the error",
|
|
"example": []
|
|
}
|
|
},
|
|
"required": [
|
|
"message",
|
|
"code"
|
|
],
|
|
"title": "Error",
|
|
"description": "The error information",
|
|
"example": {
|
|
"code": "UNAUTHORIZED",
|
|
"message": "Authorization not provided",
|
|
"issues": []
|
|
}
|
|
},
|
|
"error.FORBIDDEN": {
|
|
"type": "object",
|
|
"properties": {
|
|
"message": {
|
|
"type": "string",
|
|
"description": "The error message",
|
|
"example": "Insufficient access"
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"description": "The error code",
|
|
"example": "FORBIDDEN"
|
|
},
|
|
"issues": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"message": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"message"
|
|
]
|
|
},
|
|
"description": "An array of issues that were responsible for the error",
|
|
"example": []
|
|
}
|
|
},
|
|
"required": [
|
|
"message",
|
|
"code"
|
|
],
|
|
"title": "Error",
|
|
"description": "The error information",
|
|
"example": {
|
|
"code": "FORBIDDEN",
|
|
"message": "Insufficient access",
|
|
"issues": []
|
|
}
|
|
},
|
|
"error.NOT_FOUND": {
|
|
"type": "object",
|
|
"properties": {
|
|
"message": {
|
|
"type": "string",
|
|
"description": "The error message",
|
|
"example": "Not found"
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"description": "The error code",
|
|
"example": "NOT_FOUND"
|
|
},
|
|
"issues": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"message": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"message"
|
|
]
|
|
},
|
|
"description": "An array of issues that were responsible for the error",
|
|
"example": []
|
|
}
|
|
},
|
|
"required": [
|
|
"message",
|
|
"code"
|
|
],
|
|
"title": "Error",
|
|
"description": "The error information",
|
|
"example": {
|
|
"code": "NOT_FOUND",
|
|
"message": "Not found",
|
|
"issues": []
|
|
}
|
|
},
|
|
"error.INTERNAL_SERVER_ERROR": {
|
|
"type": "object",
|
|
"properties": {
|
|
"message": {
|
|
"type": "string",
|
|
"description": "The error message",
|
|
"example": "Internal server error"
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"description": "The error code",
|
|
"example": "INTERNAL_SERVER_ERROR"
|
|
},
|
|
"issues": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"message": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"message"
|
|
]
|
|
},
|
|
"description": "An array of issues that were responsible for the error",
|
|
"example": []
|
|
}
|
|
},
|
|
"required": [
|
|
"message",
|
|
"code"
|
|
],
|
|
"title": "Error",
|
|
"description": "The error information",
|
|
"example": {
|
|
"code": "INTERNAL_SERVER_ERROR",
|
|
"message": "Internal server error",
|
|
"issues": []
|
|
}
|
|
},
|
|
"event": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"graphCoordinates": {
|
|
"type": "object",
|
|
"properties": {
|
|
"x": {
|
|
"type": "number"
|
|
},
|
|
"y": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"x",
|
|
"y"
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"start"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"graphCoordinates",
|
|
"type"
|
|
],
|
|
"description": "Event"
|
|
},
|
|
"theme": {
|
|
"type": "object",
|
|
"properties": {
|
|
"general": {
|
|
"type": "object",
|
|
"properties": {
|
|
"font": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Google"
|
|
]
|
|
},
|
|
"family": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Custom"
|
|
]
|
|
},
|
|
"family": {
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"background": {
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Color",
|
|
"Image",
|
|
"None"
|
|
]
|
|
},
|
|
"content": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"chat": {
|
|
"type": "object",
|
|
"properties": {
|
|
"hostAvatar": {
|
|
"type": "object",
|
|
"properties": {
|
|
"isEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"guestAvatar": {
|
|
"type": "object",
|
|
"properties": {
|
|
"isEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"hostBubbles": {
|
|
"type": "object",
|
|
"properties": {
|
|
"backgroundColor": {
|
|
"type": "string"
|
|
},
|
|
"color": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"guestBubbles": {
|
|
"type": "object",
|
|
"properties": {
|
|
"backgroundColor": {
|
|
"type": "string"
|
|
},
|
|
"color": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"buttons": {
|
|
"type": "object",
|
|
"properties": {
|
|
"backgroundColor": {
|
|
"type": "string"
|
|
},
|
|
"color": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"inputs": {
|
|
"type": "object",
|
|
"properties": {
|
|
"backgroundColor": {
|
|
"type": "string"
|
|
},
|
|
"color": {
|
|
"type": "string"
|
|
},
|
|
"placeholderColor": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"roundness": {
|
|
"type": "string",
|
|
"enum": [
|
|
"none",
|
|
"medium",
|
|
"large"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"customCss": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "Theme"
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"typingEmulation": {
|
|
"type": "object",
|
|
"properties": {
|
|
"enabled": {
|
|
"type": "boolean"
|
|
},
|
|
"speed": {
|
|
"type": "number"
|
|
},
|
|
"maxDelay": {
|
|
"type": "number"
|
|
},
|
|
"delayBetweenBubbles": {
|
|
"type": "number",
|
|
"minimum": 0,
|
|
"maximum": 5
|
|
},
|
|
"isDisabledOnFirstMessage": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"properties": {
|
|
"title": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"imageUrl": {
|
|
"type": "string"
|
|
},
|
|
"favIconUrl": {
|
|
"type": "string"
|
|
},
|
|
"customHeadCode": {
|
|
"type": "string"
|
|
},
|
|
"googleTagManagerId": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"whatsApp": {
|
|
"type": "object",
|
|
"properties": {
|
|
"isEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"logicalOperator",
|
|
"comparisons"
|
|
]
|
|
},
|
|
"sessionExpiryTimeout": {
|
|
"type": "number",
|
|
"minimum": 0.01,
|
|
"maximum": 48,
|
|
"description": "Expiration delay in hours after latest interaction"
|
|
}
|
|
}
|
|
},
|
|
"publicShare": {
|
|
"type": "object",
|
|
"properties": {
|
|
"isEnabled": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"security": {
|
|
"type": "object",
|
|
"properties": {
|
|
"allowedOrigins": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"title": "Settings"
|
|
},
|
|
"typebotV6": {
|
|
"type": "object",
|
|
"properties": {
|
|
"version": {
|
|
"type": "string",
|
|
"enum": [
|
|
"6"
|
|
]
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"events": {
|
|
"type": "array",
|
|
"maxItems": 1,
|
|
"minItems": 1,
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/event"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"groups": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/groupV6"
|
|
}
|
|
},
|
|
"edges": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"from": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"blockId": {
|
|
"type": "string"
|
|
},
|
|
"itemId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"blockId"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"eventId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"eventId"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"to": {
|
|
"type": "object",
|
|
"properties": {
|
|
"groupId": {
|
|
"type": "string"
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"groupId"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"from",
|
|
"to"
|
|
]
|
|
}
|
|
},
|
|
"variables": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"nullable": true,
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"name"
|
|
]
|
|
}
|
|
},
|
|
"theme": {
|
|
"$ref": "#/components/schemas/theme"
|
|
},
|
|
"selectedThemeTemplateId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"settings": {
|
|
"$ref": "#/components/schemas/settings"
|
|
},
|
|
"createdAt": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"type": "string"
|
|
},
|
|
"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",
|
|
"nullable": true,
|
|
"properties": {
|
|
"columnsOrder": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"columnsVisibility": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"columnsWidth": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "number"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"columnsOrder",
|
|
"columnsVisibility",
|
|
"columnsWidth"
|
|
]
|
|
},
|
|
"isArchived": {
|
|
"type": "boolean"
|
|
},
|
|
"isClosed": {
|
|
"type": "boolean"
|
|
},
|
|
"whatsAppCredentialsId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"riskLevel": {
|
|
"type": "number",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"version",
|
|
"id",
|
|
"name",
|
|
"events",
|
|
"groups",
|
|
"edges",
|
|
"variables",
|
|
"theme",
|
|
"selectedThemeTemplateId",
|
|
"settings",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"icon",
|
|
"folderId",
|
|
"publicId",
|
|
"customDomain",
|
|
"workspaceId",
|
|
"resultsTablePreferences",
|
|
"isArchived",
|
|
"isClosed",
|
|
"whatsAppCredentialsId",
|
|
"riskLevel"
|
|
],
|
|
"title": "Typebot V6"
|
|
},
|
|
"typebotV5": {
|
|
"type": "object",
|
|
"properties": {
|
|
"version": {
|
|
"type": "string",
|
|
"enum": [
|
|
"3",
|
|
"4",
|
|
"5"
|
|
]
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"events": {
|
|
"type": "array"
|
|
},
|
|
"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"
|
|
]
|
|
},
|
|
"blocks": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"start"
|
|
]
|
|
},
|
|
"label": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type",
|
|
"label"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"text"
|
|
]
|
|
},
|
|
"content": {
|
|
"type": "object",
|
|
"properties": {
|
|
"html": {
|
|
"type": "string"
|
|
},
|
|
"richText": {
|
|
"type": "array",
|
|
"items": {}
|
|
},
|
|
"plainText": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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",
|
|
"tiktok",
|
|
"gumlet"
|
|
]
|
|
},
|
|
"height": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{}
|
|
]
|
|
},
|
|
"aspectRatio": {
|
|
"type": "string"
|
|
},
|
|
"maxWidth": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"embed"
|
|
]
|
|
},
|
|
"content": {
|
|
"type": "object",
|
|
"properties": {
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"height": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"audio"
|
|
]
|
|
},
|
|
"content": {
|
|
"type": "object",
|
|
"properties": {
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"isAutoplayEnabled": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/textInput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/buttonsInputV5"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/email"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/numberInput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/url"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/phoneNumberInput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/dateInput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/paymentInput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/rating"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/fileInputV5"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/pictureChoiceV5"
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Code"
|
|
]
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"shouldExecuteInParentContext": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Condition"
|
|
]
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type",
|
|
"items"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Redirect"
|
|
]
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"isNewTab": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Set variable"
|
|
]
|
|
},
|
|
"options": {
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"expressionToEvaluate": {
|
|
"type": "string"
|
|
},
|
|
"isCode": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Now",
|
|
"Yesterday",
|
|
"Tomorrow"
|
|
]
|
|
},
|
|
"timeZone": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Today",
|
|
"Moment of the day",
|
|
"Empty",
|
|
"Environment name",
|
|
"User ID",
|
|
"Result ID",
|
|
"Random ID",
|
|
"Phone number",
|
|
"Contact name"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Custom"
|
|
]
|
|
},
|
|
"expressionToEvaluate": {
|
|
"type": "string"
|
|
},
|
|
"isCode": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Map item with same index"
|
|
]
|
|
},
|
|
"mapListItemParams": {
|
|
"type": "object",
|
|
"properties": {
|
|
"baseItemVariableId": {
|
|
"type": "string"
|
|
},
|
|
"baseListVariableId": {
|
|
"type": "string"
|
|
},
|
|
"targetListVariableId": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Append value(s)"
|
|
]
|
|
},
|
|
"item": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Typebot link"
|
|
]
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"typebotId": {
|
|
"type": "string"
|
|
},
|
|
"groupId": {
|
|
"type": "string"
|
|
},
|
|
"mergeResults": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Wait"
|
|
]
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"secondsToWaitFor": {
|
|
"type": "string"
|
|
},
|
|
"shouldPause": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Jump"
|
|
]
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"groupId": {
|
|
"type": "string"
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"AB test"
|
|
]
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"maxItems": 2,
|
|
"minItems": 2,
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"path": {
|
|
"type": "string",
|
|
"enum": [
|
|
"a"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"path"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"path": {
|
|
"type": "string",
|
|
"enum": [
|
|
"b"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"path"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"aPercent": {
|
|
"type": "number",
|
|
"minimum": 0,
|
|
"maximum": 100
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type",
|
|
"items"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Google Sheets"
|
|
]
|
|
},
|
|
"options": {
|
|
"oneOf": [
|
|
{
|
|
"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"
|
|
]
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"logicalOperator": {
|
|
"type": "string",
|
|
"enum": [
|
|
"OR",
|
|
"AND"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"cellsToExtract": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"column": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"totalRowsToExtract": {
|
|
"type": "string",
|
|
"enum": [
|
|
"All",
|
|
"First",
|
|
"Last",
|
|
"Random"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"action"
|
|
]
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"action"
|
|
]
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"referenceCell": {
|
|
"type": "object",
|
|
"properties": {
|
|
"column": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"logicalOperator": {
|
|
"type": "string",
|
|
"enum": [
|
|
"OR",
|
|
"AND"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"action"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"sheetId": {
|
|
"type": "string"
|
|
},
|
|
"spreadsheetId": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"responseVariableMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"bodyPath": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"headers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"method": {
|
|
"type": "string",
|
|
"enum": [
|
|
"POST",
|
|
"GET",
|
|
"PUT",
|
|
"DELETE",
|
|
"PATCH",
|
|
"HEAD",
|
|
"CONNECT",
|
|
"OPTIONS",
|
|
"TRACE"
|
|
]
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"body": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"timeout": {
|
|
"type": "number",
|
|
"minimum": 1,
|
|
"maximum": 120
|
|
}
|
|
}
|
|
},
|
|
"webhookId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"OpenAI"
|
|
]
|
|
},
|
|
"options": {
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"baseUrl": {
|
|
"type": "string"
|
|
},
|
|
"apiVersion": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"role": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Messages sequence ✨"
|
|
]
|
|
},
|
|
"content": {
|
|
"type": "object",
|
|
"properties": {
|
|
"assistantMessagesVariableId": {
|
|
"type": "string"
|
|
},
|
|
"userMessagesVariableId": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"role"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"role": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Dialogue"
|
|
]
|
|
},
|
|
"dialogueVariableId": {
|
|
"type": "string"
|
|
},
|
|
"startsBy": {
|
|
"type": "string",
|
|
"enum": [
|
|
"user",
|
|
"assistant"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"role"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"advancedSettings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"temperature": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"responseMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"valueToExtract": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Message content",
|
|
"Total tokens"
|
|
]
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"valueToExtract"
|
|
]
|
|
}
|
|
},
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"baseUrl": {
|
|
"type": "string"
|
|
},
|
|
"apiVersion": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"task"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"task": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Create image"
|
|
]
|
|
},
|
|
"prompt": {
|
|
"type": "string"
|
|
},
|
|
"advancedOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"size": {
|
|
"type": "string",
|
|
"enum": [
|
|
"256x256",
|
|
"512x512",
|
|
"1024x1024"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"responseMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"valueToExtract": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Image URL"
|
|
]
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"valueToExtract"
|
|
]
|
|
}
|
|
},
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"baseUrl": {
|
|
"type": "string"
|
|
},
|
|
"apiVersion": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"task",
|
|
"advancedOptions",
|
|
"responseMapping"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"baseUrl": {
|
|
"type": "string"
|
|
},
|
|
"apiVersion": {
|
|
"type": "string"
|
|
},
|
|
"task": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Create speech"
|
|
]
|
|
},
|
|
"model": {
|
|
"type": "string"
|
|
},
|
|
"input": {
|
|
"type": "string"
|
|
},
|
|
"voice": {
|
|
"type": "string",
|
|
"enum": [
|
|
"alloy",
|
|
"echo",
|
|
"fable",
|
|
"onyx",
|
|
"nova",
|
|
"shimmer"
|
|
]
|
|
},
|
|
"saveUrlInVariableId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"task"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"responseVariableMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"bodyPath": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"headers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"method": {
|
|
"type": "string",
|
|
"enum": [
|
|
"POST",
|
|
"GET",
|
|
"PUT",
|
|
"DELETE",
|
|
"PATCH",
|
|
"HEAD",
|
|
"CONNECT",
|
|
"OPTIONS",
|
|
"TRACE"
|
|
]
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"body": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"timeout": {
|
|
"type": "number",
|
|
"minimum": 1,
|
|
"maximum": 120
|
|
}
|
|
}
|
|
},
|
|
"webhookId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Webhook"
|
|
],
|
|
"description": "Legacy name for HTTP Request block"
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"variablesForTest": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"responseVariableMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"bodyPath": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"headers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"method": {
|
|
"type": "string",
|
|
"enum": [
|
|
"POST",
|
|
"GET",
|
|
"PUT",
|
|
"DELETE",
|
|
"PATCH",
|
|
"HEAD",
|
|
"CONNECT",
|
|
"OPTIONS",
|
|
"TRACE"
|
|
]
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"body": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"timeout": {
|
|
"type": "number",
|
|
"minimum": 1,
|
|
"maximum": 120
|
|
}
|
|
}
|
|
},
|
|
"webhookId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"responseVariableMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"bodyPath": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"headers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"method": {
|
|
"type": "string",
|
|
"enum": [
|
|
"POST",
|
|
"GET",
|
|
"PUT",
|
|
"DELETE",
|
|
"PATCH",
|
|
"HEAD",
|
|
"CONNECT",
|
|
"OPTIONS",
|
|
"TRACE"
|
|
]
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"body": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"timeout": {
|
|
"type": "number",
|
|
"minimum": 1,
|
|
"maximum": 120
|
|
}
|
|
}
|
|
},
|
|
"webhookId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Pixel"
|
|
]
|
|
},
|
|
"options": {
|
|
"oneOf": [
|
|
{
|
|
"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"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"eventType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Lead",
|
|
"Contact",
|
|
"CompleteRegistration",
|
|
"Schedule",
|
|
"SubmitApplication",
|
|
"ViewContent",
|
|
"AddPaymentInfo",
|
|
"AddToCart",
|
|
"AddToWishlist",
|
|
"CustomizeProduct",
|
|
"Donate",
|
|
"FindLocation",
|
|
"InitiateCheckout",
|
|
"Purchase",
|
|
"Search",
|
|
"StartTrial",
|
|
"Subscribe"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"eventType"
|
|
]
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"eventType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Custom"
|
|
]
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"eventType"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Zemantic AI"
|
|
]
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"systemPrompt": {
|
|
"type": "string"
|
|
},
|
|
"prompt": {
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"type": "string"
|
|
},
|
|
"maxResults": {
|
|
"type": "integer"
|
|
},
|
|
"responseMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"valueToExtract": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Summary",
|
|
"Results"
|
|
]
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"valueToExtract"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"title",
|
|
"graphCoordinates",
|
|
"blocks"
|
|
]
|
|
}
|
|
},
|
|
"edges": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"from": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"blockId": {
|
|
"type": "string"
|
|
},
|
|
"itemId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"blockId"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"eventId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"eventId"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"to": {
|
|
"type": "object",
|
|
"properties": {
|
|
"groupId": {
|
|
"type": "string"
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"groupId"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"from",
|
|
"to"
|
|
]
|
|
}
|
|
},
|
|
"variables": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"nullable": true,
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"name"
|
|
]
|
|
}
|
|
},
|
|
"theme": {
|
|
"$ref": "#/components/schemas/theme"
|
|
},
|
|
"selectedThemeTemplateId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"settings": {
|
|
"$ref": "#/components/schemas/settings"
|
|
},
|
|
"createdAt": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"type": "string"
|
|
},
|
|
"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",
|
|
"nullable": true,
|
|
"properties": {
|
|
"columnsOrder": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"columnsVisibility": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"columnsWidth": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "number"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"columnsOrder",
|
|
"columnsVisibility",
|
|
"columnsWidth"
|
|
]
|
|
},
|
|
"isArchived": {
|
|
"type": "boolean"
|
|
},
|
|
"isClosed": {
|
|
"type": "boolean"
|
|
},
|
|
"whatsAppCredentialsId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"riskLevel": {
|
|
"type": "number",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"version",
|
|
"id",
|
|
"name",
|
|
"events",
|
|
"groups",
|
|
"edges",
|
|
"variables",
|
|
"theme",
|
|
"selectedThemeTemplateId",
|
|
"settings",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"icon",
|
|
"folderId",
|
|
"publicId",
|
|
"customDomain",
|
|
"workspaceId",
|
|
"resultsTablePreferences",
|
|
"isArchived",
|
|
"isClosed",
|
|
"whatsAppCredentialsId",
|
|
"riskLevel"
|
|
],
|
|
"title": "Typebot V5"
|
|
},
|
|
"publicTypebotV6": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "string",
|
|
"enum": [
|
|
"6"
|
|
]
|
|
},
|
|
"createdAt": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"type": "string"
|
|
},
|
|
"typebotId": {
|
|
"type": "string"
|
|
},
|
|
"groups": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/groupV6"
|
|
}
|
|
},
|
|
"events": {
|
|
"type": "array",
|
|
"maxItems": 1,
|
|
"minItems": 1,
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/components/schemas/event"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"edges": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"from": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"blockId": {
|
|
"type": "string"
|
|
},
|
|
"itemId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"blockId"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"eventId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"eventId"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"to": {
|
|
"type": "object",
|
|
"properties": {
|
|
"groupId": {
|
|
"type": "string"
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"groupId"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"from",
|
|
"to"
|
|
]
|
|
}
|
|
},
|
|
"variables": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"nullable": true,
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"name"
|
|
]
|
|
}
|
|
},
|
|
"theme": {
|
|
"$ref": "#/components/schemas/theme"
|
|
},
|
|
"settings": {
|
|
"$ref": "#/components/schemas/settings"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"version",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"typebotId",
|
|
"groups",
|
|
"events",
|
|
"edges",
|
|
"variables",
|
|
"theme",
|
|
"settings"
|
|
],
|
|
"title": "Public Typebot V6"
|
|
},
|
|
"publicTypebotV5": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "string",
|
|
"enum": [
|
|
"3",
|
|
"4",
|
|
"5"
|
|
]
|
|
},
|
|
"createdAt": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"type": "string"
|
|
},
|
|
"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"
|
|
]
|
|
},
|
|
"blocks": {
|
|
"type": "array",
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"start"
|
|
]
|
|
},
|
|
"label": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type",
|
|
"label"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"text"
|
|
]
|
|
},
|
|
"content": {
|
|
"type": "object",
|
|
"properties": {
|
|
"html": {
|
|
"type": "string"
|
|
},
|
|
"richText": {
|
|
"type": "array",
|
|
"items": {}
|
|
},
|
|
"plainText": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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",
|
|
"tiktok",
|
|
"gumlet"
|
|
]
|
|
},
|
|
"height": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{}
|
|
]
|
|
},
|
|
"aspectRatio": {
|
|
"type": "string"
|
|
},
|
|
"maxWidth": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"embed"
|
|
]
|
|
},
|
|
"content": {
|
|
"type": "object",
|
|
"properties": {
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"height": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"audio"
|
|
]
|
|
},
|
|
"content": {
|
|
"type": "object",
|
|
"properties": {
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"isAutoplayEnabled": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/textInput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/buttonsInputV5"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/email"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/numberInput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/url"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/phoneNumberInput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/dateInput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/paymentInput"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/rating"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/fileInputV5"
|
|
},
|
|
{
|
|
"$ref": "#/components/schemas/pictureChoiceV5"
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Code"
|
|
]
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"shouldExecuteInParentContext": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Condition"
|
|
]
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type",
|
|
"items"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Redirect"
|
|
]
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"isNewTab": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Set variable"
|
|
]
|
|
},
|
|
"options": {
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"expressionToEvaluate": {
|
|
"type": "string"
|
|
},
|
|
"isCode": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Now",
|
|
"Yesterday",
|
|
"Tomorrow"
|
|
]
|
|
},
|
|
"timeZone": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Today",
|
|
"Moment of the day",
|
|
"Empty",
|
|
"Environment name",
|
|
"User ID",
|
|
"Result ID",
|
|
"Random ID",
|
|
"Phone number",
|
|
"Contact name"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Custom"
|
|
]
|
|
},
|
|
"expressionToEvaluate": {
|
|
"type": "string"
|
|
},
|
|
"isCode": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Map item with same index"
|
|
]
|
|
},
|
|
"mapListItemParams": {
|
|
"type": "object",
|
|
"properties": {
|
|
"baseItemVariableId": {
|
|
"type": "string"
|
|
},
|
|
"baseListVariableId": {
|
|
"type": "string"
|
|
},
|
|
"targetListVariableId": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"isExecutedOnClient": {
|
|
"type": "boolean"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Append value(s)"
|
|
]
|
|
},
|
|
"item": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Typebot link"
|
|
]
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"typebotId": {
|
|
"type": "string"
|
|
},
|
|
"groupId": {
|
|
"type": "string"
|
|
},
|
|
"mergeResults": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Wait"
|
|
]
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"secondsToWaitFor": {
|
|
"type": "string"
|
|
},
|
|
"shouldPause": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Jump"
|
|
]
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"groupId": {
|
|
"type": "string"
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"AB test"
|
|
]
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"maxItems": 2,
|
|
"minItems": 2,
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"path": {
|
|
"type": "string",
|
|
"enum": [
|
|
"a"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"path"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"path": {
|
|
"type": "string",
|
|
"enum": [
|
|
"b"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"path"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"aPercent": {
|
|
"type": "number",
|
|
"minimum": 0,
|
|
"maximum": 100
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type",
|
|
"items"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Google Sheets"
|
|
]
|
|
},
|
|
"options": {
|
|
"oneOf": [
|
|
{
|
|
"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"
|
|
]
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"logicalOperator": {
|
|
"type": "string",
|
|
"enum": [
|
|
"OR",
|
|
"AND"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"cellsToExtract": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"column": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"totalRowsToExtract": {
|
|
"type": "string",
|
|
"enum": [
|
|
"All",
|
|
"First",
|
|
"Last",
|
|
"Random"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"action"
|
|
]
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"action"
|
|
]
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"referenceCell": {
|
|
"type": "object",
|
|
"properties": {
|
|
"column": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"logicalOperator": {
|
|
"type": "string",
|
|
"enum": [
|
|
"OR",
|
|
"AND"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"action"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"sheetId": {
|
|
"type": "string"
|
|
},
|
|
"spreadsheetId": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"responseVariableMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"bodyPath": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"headers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"method": {
|
|
"type": "string",
|
|
"enum": [
|
|
"POST",
|
|
"GET",
|
|
"PUT",
|
|
"DELETE",
|
|
"PATCH",
|
|
"HEAD",
|
|
"CONNECT",
|
|
"OPTIONS",
|
|
"TRACE"
|
|
]
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"body": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"timeout": {
|
|
"type": "number",
|
|
"minimum": 1,
|
|
"maximum": 120
|
|
}
|
|
}
|
|
},
|
|
"webhookId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"OpenAI"
|
|
]
|
|
},
|
|
"options": {
|
|
"oneOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"baseUrl": {
|
|
"type": "string"
|
|
},
|
|
"apiVersion": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"role": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Messages sequence ✨"
|
|
]
|
|
},
|
|
"content": {
|
|
"type": "object",
|
|
"properties": {
|
|
"assistantMessagesVariableId": {
|
|
"type": "string"
|
|
},
|
|
"userMessagesVariableId": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"role"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"role": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Dialogue"
|
|
]
|
|
},
|
|
"dialogueVariableId": {
|
|
"type": "string"
|
|
},
|
|
"startsBy": {
|
|
"type": "string",
|
|
"enum": [
|
|
"user",
|
|
"assistant"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"role"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"advancedSettings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"temperature": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"responseMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"valueToExtract": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Message content",
|
|
"Total tokens"
|
|
]
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"valueToExtract"
|
|
]
|
|
}
|
|
},
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"baseUrl": {
|
|
"type": "string"
|
|
},
|
|
"apiVersion": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"task"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"task": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Create image"
|
|
]
|
|
},
|
|
"prompt": {
|
|
"type": "string"
|
|
},
|
|
"advancedOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"size": {
|
|
"type": "string",
|
|
"enum": [
|
|
"256x256",
|
|
"512x512",
|
|
"1024x1024"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"responseMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"valueToExtract": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Image URL"
|
|
]
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"valueToExtract"
|
|
]
|
|
}
|
|
},
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"baseUrl": {
|
|
"type": "string"
|
|
},
|
|
"apiVersion": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"task",
|
|
"advancedOptions",
|
|
"responseMapping"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"baseUrl": {
|
|
"type": "string"
|
|
},
|
|
"apiVersion": {
|
|
"type": "string"
|
|
},
|
|
"task": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Create speech"
|
|
]
|
|
},
|
|
"model": {
|
|
"type": "string"
|
|
},
|
|
"input": {
|
|
"type": "string"
|
|
},
|
|
"voice": {
|
|
"type": "string",
|
|
"enum": [
|
|
"alloy",
|
|
"echo",
|
|
"fable",
|
|
"onyx",
|
|
"nova",
|
|
"shimmer"
|
|
]
|
|
},
|
|
"saveUrlInVariableId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"task"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"responseVariableMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"bodyPath": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"headers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"method": {
|
|
"type": "string",
|
|
"enum": [
|
|
"POST",
|
|
"GET",
|
|
"PUT",
|
|
"DELETE",
|
|
"PATCH",
|
|
"HEAD",
|
|
"CONNECT",
|
|
"OPTIONS",
|
|
"TRACE"
|
|
]
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"body": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"timeout": {
|
|
"type": "number",
|
|
"minimum": 1,
|
|
"maximum": 120
|
|
}
|
|
}
|
|
},
|
|
"webhookId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Webhook"
|
|
],
|
|
"description": "Legacy name for HTTP Request block"
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"variablesForTest": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"responseVariableMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"bodyPath": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"headers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"method": {
|
|
"type": "string",
|
|
"enum": [
|
|
"POST",
|
|
"GET",
|
|
"PUT",
|
|
"DELETE",
|
|
"PATCH",
|
|
"HEAD",
|
|
"CONNECT",
|
|
"OPTIONS",
|
|
"TRACE"
|
|
]
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"body": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"timeout": {
|
|
"type": "number",
|
|
"minimum": 1,
|
|
"maximum": 120
|
|
}
|
|
}
|
|
},
|
|
"webhookId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"responseVariableMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
},
|
|
"bodyPath": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"headers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"method": {
|
|
"type": "string",
|
|
"enum": [
|
|
"POST",
|
|
"GET",
|
|
"PUT",
|
|
"DELETE",
|
|
"PATCH",
|
|
"HEAD",
|
|
"CONNECT",
|
|
"OPTIONS",
|
|
"TRACE"
|
|
]
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"body": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
},
|
|
"timeout": {
|
|
"type": "number",
|
|
"minimum": 1,
|
|
"maximum": 120
|
|
}
|
|
}
|
|
},
|
|
"webhookId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Pixel"
|
|
]
|
|
},
|
|
"options": {
|
|
"oneOf": [
|
|
{
|
|
"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"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"eventType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Lead",
|
|
"Contact",
|
|
"CompleteRegistration",
|
|
"Schedule",
|
|
"SubmitApplication",
|
|
"ViewContent",
|
|
"AddPaymentInfo",
|
|
"AddToCart",
|
|
"AddToWishlist",
|
|
"CustomizeProduct",
|
|
"Donate",
|
|
"FindLocation",
|
|
"InitiateCheckout",
|
|
"Purchase",
|
|
"Search",
|
|
"StartTrial",
|
|
"Subscribe"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"eventType"
|
|
]
|
|
},
|
|
{
|
|
"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"
|
|
]
|
|
}
|
|
},
|
|
"eventType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Custom"
|
|
]
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"eventType"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"outgoingEdgeId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Zemantic AI"
|
|
]
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"credentialsId": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"systemPrompt": {
|
|
"type": "string"
|
|
},
|
|
"prompt": {
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"type": "string"
|
|
},
|
|
"maxResults": {
|
|
"type": "integer"
|
|
},
|
|
"responseMapping": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"valueToExtract": {
|
|
"type": "string",
|
|
"enum": [
|
|
"Summary",
|
|
"Results"
|
|
]
|
|
},
|
|
"variableId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"valueToExtract"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"type"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"title",
|
|
"graphCoordinates",
|
|
"blocks"
|
|
]
|
|
}
|
|
},
|
|
"events": {
|
|
"type": "array"
|
|
},
|
|
"edges": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"from": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"blockId": {
|
|
"type": "string"
|
|
},
|
|
"itemId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"blockId"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"eventId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"eventId"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"to": {
|
|
"type": "object",
|
|
"properties": {
|
|
"groupId": {
|
|
"type": "string"
|
|
},
|
|
"blockId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"groupId"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"from",
|
|
"to"
|
|
]
|
|
}
|
|
},
|
|
"variables": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"nullable": true,
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"name"
|
|
]
|
|
}
|
|
},
|
|
"theme": {
|
|
"$ref": "#/components/schemas/theme"
|
|
},
|
|
"settings": {
|
|
"$ref": "#/components/schemas/settings"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"version",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"typebotId",
|
|
"groups",
|
|
"events",
|
|
"edges",
|
|
"variables",
|
|
"theme",
|
|
"settings"
|
|
],
|
|
"title": "Public Typebot V5"
|
|
}
|
|
}
|
|
}
|
|
} |