> ## Documentation Index
> Fetch the complete documentation index at: https://docs.liberate.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

# Workflow Builder Quickstart

Build automated workflows that connect your systems and process insurance transactions—no code required, ready in 15 minutes.

> [!NOTE]
>
> **What you'll build:** A workflow that receives claim data, transforms it, and prepares it for your claims system.
>
> **Time to complete:** 15-20 minutes

## Prerequisites

**1. Access your Liberate instance**

Log in to your platform at `yourcompany-ui.liberateinc.com`

**2. Verify permissions**

You need workflow creation permissions. If you don't see a "Create Workflow" button, contact your administrator.

## Understanding Environments

Liberate provides three environments for building and deploying workflows:

| Environment | Purpose | When to Use |
| - | - | - |
| **Preview** | Development and testing | While building—test your logic here first |
| **QA** | Stakeholder validation | When ready for business review |
| **Production** | Live workflows | After validation, for real traffic |

> [!WARNING]
>
> Workflows run in whichever environment you've selected. Always start in Preview, then QA, then Production.

***

## Step 1: Create a Project

Projects are folders that group related workflows together.

1. Navigate to the left panel
2. Click **Create Project** or select an existing project
3. Give it a descriptive name (e.g., "Claims Intake Workflows")

***

## Step 2: Create Your Workflow

1. Click **Create Workflow** within your project
2. A **Start Event Node** is automatically added to your canvas

Every workflow requires a Start Event Node—this is where data enters your workflow.

### Configure the Start Event Node

Click the Start Event Node to open its settings:

> [tab] Execution Mode
>
> Choose how your workflow responds when triggered:
>
> | Mode | Behavior | Best For |
> | - | - | - |
> | **Async** (recommended) | Returns immediately, processes in background | FNOL intake, claims processing, policy updates |
> | **Sync** | Waits for completion before responding | Real-time lookups, instant validation |
>
> > [!TIP]
> >
> > Use **Async** for most workflows. It handles long-running processes without timeouts.

> [tab] Default Data
>
> Click **+ Set Default workflow content** to define the initial data structure.
>
> Every workflow automatically includes:
>
> ```json theme={null}
> {
>   "tenantId": "your-company",      // Your identifier
>   "environment": "preview",         // Current environment
>   "instanceId": "exec-12345",       // Unique execution ID
>   "correlationId": "abc-123-def"    // Links related workflows
> }
> ```
>
> You'll add your business data on top of these system properties.

> [tab] Manual Trigger
>
> The Start Event displays cURL commands to manually trigger your workflow via HTTP. Useful for testing.

***

## Step 3: Add a Mapping Node

**Mapping Nodes** transform data as it flows through your workflow. Use them to combine fields, format values, or restructure data.

### Example: Format Claimant Information

Let's transform incoming claim data into the format your claims system expects.

1. Click **+** to add a node
2. Select **Mapping Node**
3. Click **+ Add mapping transformation**

> [tab] Input Data
>
> Paste sample data to test your transformation:
>
> ```json theme={null}
> {
>   "claimant": {
>     "firstName": "John",
>     "lastName": "Smith"
>   },
>   "policyNumber": "HO-12345678",
>   "lossDate": "2025-02-10",
>   "lossType": "water_damage",
>   "lossDescription": "Pipe burst in basement"
> }
> ```

> [tab] Transformation
>
> Write a JSONata expression to transform the data:
>
> ```jsonata theme={null}
> {
>   "claimantFullName": claimant.firstName & " " & claimant.lastName,
>   "formattedLossDate": $fromMillis($toMillis(lossDate), "[M01]/[D01]/[Y0001]"),
>   "claimSummary": lossType & ": " & lossDescription
> }
> ```
>
> [Learn JSONata syntax →](https://jsonata.org/)

> [tab] Output
>
> See the result in real-time:
>
> ```json theme={null}
> {
>   "claimant": { "firstName": "John", "lastName": "Smith" },
>   "policyNumber": "HO-12345678",
>   "lossDate": "2025-02-10",
>   "lossType": "water_damage",
>   "lossDescription": "Pipe burst in basement",
>   "claimantFullName": "John Smith",
>   "formattedLossDate": "02/10/2025",
>   "claimSummary": "water_damage: Pipe burst in basement"
> }
> ```

### Merge vs. Replace

The **Merge** toggle controls how output is applied:

| Setting | Behavior | Recommendation |
| - | - | - |
| **Merge ON** (blue) | Keeps existing data, adds new fields | ✅ Use this (default) |
| **Merge OFF** | Replaces all data with output only | ⚠️ Use with caution |

> [!WARNING]
>
> **Two-Step Save Required!**
>
> 1. Click **Save** in the expression editor (left panel)
> 2. Click **Save** in the node settings (right panel)
>
> If you only save once, your changes will be lost.

***

## Step 4: Add an End Node

Every workflow needs an End Node to mark completion.

1. Click **+** to add a node
2. Select **End Event Node**
3. Connect it to your Mapping Node

Your workflow structure:

```
Start Event → Mapping Node → End Event
```

***

## Step 5: Test Your Workflow

1. Click **Preview flow** in the left navigation
2. Paste your test data:

```json theme={null}
{
  "claimant": {
    "firstName": "Jane",
    "lastName": "Green"
  },
  "policyNumber": "HO-98765432",
  "lossDate": "2025-02-11",
  "lossType": "theft",
  "lossDescription": "Laptop stolen from vehicle"
}
```

3. Click **Run flow**
4. Monitor execution in the **Logs** panel

### Reading the Logs

| Log Entry | Meaning |
| - | - |
| ✅ Green checkmarks | Node executed successfully |
| `***` asterisks | PII data automatically masked for security |
| ❌ Red errors | Something failed—check the message |

> [!TIP]
>
> Run your workflow multiple times with different test data before moving to QA.

***

## Step 6: Add External Integrations (Optional)

**Task Nodes** connect to external systems like your AMS, claims platform, or CRM.

### Setting Up a Connection

Before using a Task Node, create a connection to your external system:

1. Click **Connections** in the left sidebar
2. Click **Create a connection**
3. Select the connection type (REST API, Salesforce, AWS, etc.)
4. Configure credentials for **QA** and **Production** environments

> [accordion] Example: REST API Connection
>
> ```
> Name: Claims System API
> Type: REST - Basic Authentication
>
> QA Environment:
>   Base URL: https://test-api.claimssystem.com
>   Username: api_user_qa
>   Password: ********
>
> Production Environment:
>   Base URL: https://api.claimssystem.com
>   Username: api_user_prod
>   Password: ********
> ```

### Adding a Task Node

1. Add a **Task Node** to your workflow
2. Select your connection from the dropdown
3. Configure the request:

| Setting | Description |
| - | - |
| **Method** | POST, GET, PUT, DELETE, etc. |
| **URL** | Endpoint path (appended to base URL) |
| **Request Transformation** | Map workflow data to API request |
| **Response Handling** | Where to store the response |

### Retry Strategy

Configure how failed requests are handled:

| Strategy | Behavior |
| - | - |
| **Linear** | Same delay between retries (1s, 1s, 1s) |
| **Exponential** | Increasing delay (1s, 2s, 4s, 8s) |
| **None** | No retries |

Set **Times** (retry count), **Delay** (milliseconds), and **Status Codes** to retry on (e.g., 500, 502, 503).

***

## Validation Checklist

Before moving to QA, verify:

* [ ] All nodes show green checkmarks in test runs
* [ ] Data transforms correctly (even if masked as `***`)
* [ ] No error messages in execution logs
* [ ] Final output matches expected format
* [ ] Multiple test scenarios pass

***

## Next Steps

> [card] [Core Concepts](https://docs.liberate.ai/workflows/concepts/context.md)
>
> Learn how data flows through workflows

> [card] [Node Reference](https://docs.liberate.ai/workflows/nodes/mapping-node.md)
>
> Detailed documentation for each node type

> [card] [FNOL Example](https://docs.liberate.ai/workflows/examples/fnol-workflow.md)
>
> Build a complete claims intake workflow

> [card] [Connections Guide](https://docs.liberate.ai/workflows/concepts/connections.md)
>
> Set up integrations with your systems


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.