Types Reference
Base Types
ApiConfig
Configuration for API calls within workflow steps. This type is used internally byExecutionStep to define how each step calls an API.
Note:ApiConfigis used within workflow steps. For creating integrations and workflows, useIntegrationandWorkflowtypes.
Workflow
Configuration for multi-step workflows. Inherits from BaseConfig.WorkflowSchedule
Configuration for scheduled workflow execution. Workflows can be executed on a recurring schedule using cron expressions.- Uses standard 5-field cron syntax:
minute hour day month weekday - Minute: 0-59
- Hour: 0-23
- Day: 1-31
- Month: 1-12
- Weekday: 0-6 (Sunday to Saturday)
- Supports ranges (
1-5), lists (1,3,5), and steps (*/15) - Does NOT support seconds or years
0 2 * * *- Daily at 2:00 AM0 * * * *- Every hour*/15 * * * *- Every 15 minutes0 9-17 * * 1-5- Every hour from 9 AM to 5 PM, Monday to Friday0 0 * * 0- Weekly on Sunday at midnight
- All schedules require a valid IANA timezone
- Next run times are calculated in the specified timezone
- Times are stored in UTC internally
- The scheduler polls every 30 seconds to check for due schedules
ExecutionStep
Individual step within a workflow.Integration
Third-party service integration configuration.SuggestedIntegration
AI-suggested integration based on natural language search terms.SuggestedTool
AI-suggested tool (workflow) based on natural language search terms.TenantInfo
Tenant account information.WorkflowResult
Result of workflow execution.WorkflowStepResult
Result of individual workflow step execution.RunResult
Result of individual operation execution.Log
Log entry for operation tracking.Pagination
Configuration for automatic pagination handling.OFFSET_BASED: Uses offset/limit parametersPAGE_BASED: Uses page number and page sizeCURSOR_BASED: Uses cursor tokens for navigationDISABLED: No automatic pagination (default)
List Types
RunList
WorkflowList
IntegrationList
Enums
HttpMethod
Available HTTP methods:GETPOSTPUTDELETEPATCHHEADOPTIONS
AuthType
Authentication methods:NONE- No authenticationHEADER- Authentication via headersQUERY_PARAM- Authentication via query parametersOAUTH2- OAuth 2.0 authentication
FileType
Supported file formats:AUTO- Automatic detectionJSON- JSON filesCSV- CSV filesXML- XML files
DecompressionMethod
Available decompression methods:NONE- No decompressionGZIP- gzip compressionDEFLATE- deflate compressionZIP- zip archivesAUTO- Automatic detection
CacheMode
Cache behavior options:ENABLED- Full cachingDISABLED- No cachingREADONLY- Read-only cache. This is the default mode.WRITEONLY- Write-only cache
PaginationType
Pagination type options:OFFSET_BASED- Offset-based paginationPAGE_BASED- Page-based paginationCURSOR_BASED- Cursor-based paginationDISABLED- Disabled pagination
LogLevel
Log level options:DEBUG- Debug levelINFO- Info levelWARN- Warn levelERROR- Error level
SelfHealingMode
Self-healing behavior options:ENABLED- Full self-healingTRANSFORM_ONLY- Transform-only self-healingREQUEST_ONLY- Request-only self-healingDISABLED- No self-healing
UpsertMode
Upsert operation modes:CREATE- Create onlyUPDATE- Update onlyUPSERT- Create or update
Subscriptions
Logs
Stream log messages in real time.id: ID of the log messagemessage: Log message stringlevel: LogLevel (DEBUG, INFO, WARN, ERROR)timestamp: DateTimerunId: ID of the related run (optional)
WorkflowResult
Result of workflow execution with detailed step results.stepResults: Array of individual step results within the workflow
WorkflowStepResult
Result of an individual step within a workflow execution.stepId: Identifier of the step within the workflowrawData: Raw response data before transformationtransformedData: Data after applying transformations
ExecutionStep
Configuration for a single step within a workflow.executionMode: How to execute the step (DIRECT for single execution, LOOP for batch processing)loopSelector: JSONata expression to select items for loopingloopMaxIters: Maximum iterations for loop mode (default: 1000)inputMapping: JSONata expression to map workflow data to step inputresponseMapping: JSONata expression to transform step output
SuggestedIntegration
Suggested integration returned byfindRelevantIntegrations query.
reason: Explanation of why this integration was suggestedsavedCredentials: Names of credentials already saved for this integration