AltScore
Workflow Builder/User Guide

Getting Started

This guide walks you through creating your first workflow in Workflow Builder V2. By the end, you will have a working workflow that makes an HTTP request and understand the basic concepts needed to build more complex automations.

What is a Workflow?

A workflow is a visual representation of a business process that executes automatically. Think of it as a flowchart that actually runs: data flows from a starting point through a series of tasks, with each task performing an action like querying a database, making an API call, or applying business logic.

Workflows consist of:

  • Nodes: Visual blocks representing tasks (HTTP requests, conditionals, data transformations)
  • Edges: Connections between nodes that define the execution order
  • Start Node: Where every workflow begins execution
  • End Node: Where the workflow terminates and returns results

Prerequisites

Before you begin, ensure you have:

  • Access to the Hub platform with workflow creation permissions
  • Basic understanding of the business process you want to automate
  • A test API endpoint (we will use a public one in this tutorial)

If you do not have workflow creation permissions, contact your administrator to request the Workflow Editor role.

Creating Your First Workflow

Step 1: Navigate to Workflows

From the Hub main menu, click on Workflows in the left sidebar. This opens the Workflows dashboard showing all workflows in your organization.

Step 2: Create a New Workflow

Click the Create Workflow button in the top right corner. A dialog appears asking for workflow details.

Step 3: Configure Workflow Identity

Fill in the following fields:

FieldDescriptionExample
AliasA unique identifier used in API calls (lowercase, no spaces)my-first-workflow
LabelA human-readable name displayed in the UIMy First Workflow
DescriptionA brief explanation of what the workflow doesTutorial workflow that fetches data from an API

Click Create to proceed.

Step 4: The Canvas Opens

You are now in the Workflow Builder canvas. Notice:

  • A Start node already exists on the left side of the canvas
  • The Components Menu is on the left sidebar
  • The Properties Panel appears when you select a node
  • The Toolbar at the top provides save, undo, and test options

Step 5: Add an End Node

Every workflow needs an End node to define where execution completes.

  1. In the Components Menu, find the Control category
  2. Drag the End component onto the canvas
  3. Position it to the right of the Start node

You can zoom in and out of the canvas using your mouse scroll wheel or trackpad pinch gesture. Pan around by clicking and dragging on empty canvas space.

Step 6: Connect Start to End

Create a connection between the Start and End nodes:

  1. Hover over the Start node until you see a small circle (handle) on its right edge
  2. Click and drag from this handle to the End node
  3. Release when hovering over the End node's left handle

A line now connects the two nodes, showing the execution path.

Step 7: Add an HTTP Task

Now add a task that does actual work. We will make an HTTP request to fetch sample data.

  1. In the Components Menu, find the HTTP category
  2. Drag the HTTP Request component onto the canvas
  3. Position it between the Start and End nodes

Step 8: Rewire the Connections

Delete the direct Start-to-End connection and create a new path:

  1. Click on the line connecting Start to End
  2. Press Delete or Backspace to remove it
  3. Connect Start to the HTTP Request node
  4. Connect the HTTP Request node to the End node

Your workflow should now flow: Start -> HTTP Request -> End

Step 9: Configure the HTTP Task

Click on the HTTP Request node to open the Properties Panel. Configure:

PropertyValue
LabelFetch Sample Data
URLhttps://jsonplaceholder.typicode.com/todos/1
MethodGET

Leave other fields at their defaults for now.

The URL used in this example is a free public API that returns sample JSON data. In real workflows, you would connect to your own APIs or AltScore data sources.

Step 10: Save the Workflow

Save your work by either:

  • Pressing Cmd+S (Mac) or Ctrl+S (Windows)
  • Clicking the Save button in the toolbar

A confirmation message appears when the workflow is saved successfully.

Step 11: Test Run the Workflow

Execute a test run to verify everything works:

  1. Click the Play button in the toolbar
  2. A dialog appears for test input (leave empty for this simple workflow)
  3. Click Execute
  4. Wait for the execution to complete

Step 12: View Results in Logs

After execution completes:

  1. Click on the Logs tab in the right panel
  2. Find your most recent execution (at the top of the list)
  3. Click to expand and view:
    • Execution status (success/failure)
    • Duration
    • Output data from each task

You should see the JSON response from the API call in the HTTP task output.

What You Learned

In this tutorial, you:

  • Created a new workflow with alias, label, and description
  • Used the visual canvas to add and position nodes
  • Connected nodes to define execution flow
  • Configured an HTTP task with URL and method
  • Saved and tested your workflow
  • Viewed execution results in the logs

Troubleshooting

Running into issues? Here are quick fixes for the most common problems.

Workflow Will Not Save

If you see an error when saving, or the Save button does not respond:

  • Make sure all required fields (marked with *) are filled in
  • Give each task a name - empty names are not allowed
  • Check that your workflow has both a Start and End node
  • Connect all your nodes - every task needs to be part of the flow (Comments are the exception)
  • Make sure there is a clear path from Start to End

HTTP Request Shows an Error

If your test run shows a red error on the HTTP Request task:

  • Double-check the URL: Even a small typo will cause an error. Make sure it starts with https://
  • Verify the method: The API you are calling expects a specific method (GET, POST, etc.). Check that yours matches
  • Add required headers: Some APIs need additional settings. Ask your API provider what headers are required
  • Check if login is needed: The API might require a key or token. Your administrator can help set this up

Cannot See Results in Logs

If your workflow runs but you do not see any output:

  • Click on the specific task you want to inspect, then open the Logs tab on the right
  • Make sure you actually ran the test (clicked the Play button) - saving alone does not run the workflow
  • Look for green borders on all nodes, which means everything completed successfully
  • Click the Refresh button in the Logs panel to load the latest results

Still not seeing results? Run the test again and watch closely. Any task that fails will turn red, showing you exactly where the problem is.

Next Steps

Now that you understand the basics, continue learning with these guides:

Remember to test workflows thoroughly with sample data before enabling them for production use. Workflow errors can affect downstream business processes.