Schemas

Overview

Schemas define the structure of data available in workflows. They enable workflow designers to understand what data is available, how to reference it, and where it can be used.

Schema Types

Account Schema

Data available at the account level:

• Configuration settings
• Global variables
• API credentials
• Environment settings

User Schema (user_data_schema)

Data specific to each user:

• User preferences
• Custom fields
• Access settings
• User-specific configurations

Trigger Schema (data_input_schema)

Data provided when a workflow starts:

• Event payloads
• Form submissions
• Scheduled event data
• API request data

Action Response Schema (response_data_schema)

Data returned from action executions:

• API responses
• Computation results
• Status information
• Error messages

Data Types

Available Types

• String: Text values
• Date: Date and time values
• Boolean: True/false values
• Integer: Whole numbers
• Float: Decimal numbers
• List: Arrays of values

Type Properties

Each data type includes:

• variable: Human-friendly name for workflow creators
• data_path: Path to locate the data (e.g., user[address][home][zip])
• type: One of the available data types
• Format specifications
• Validation rules

Nested Data

Access nested data using bracket notation. For example, to access:

1
2
3
4
5
6
7
8
9
{
  "user": {
    "address": {
      "home": {
        "zip": "33021"
      }
    }
  }
}

Use the path: user[address][home][zip]

Start using schemas →