Build your first flow

This guide builds a real, multi-step flow against a live integration: it creates a contact list in Five9, then adds a contact to that list — with the second step reading the first step’s output through an expression. You’ll go end to end: find an action in the catalog, store secrets as a credential, author and activate a definition, trigger it, and inspect the results.

You’ll need an API key (see Authentication) and Five9 admin credentials. Export both:

export BASE_URL="https://api.getdialed.ai/v1"
export GETDIALED_API_KEY="<your key>"

Find your action in the catalog

The catalog is the public registry of platforms, services, and actions you can use in flows. No authentication required. Start from the platform and drill down:

curl "$BASE_URL/catalog/platforms"

curl "$BASE_URL/catalog/platforms/five9/services"

curl "$BASE_URL/catalog/services/five9__configuration_service/actions"

The last call lists actions like:

{
  "id": "five9__configuration_service__add_to_list",
  "platform_id": "five9",
  "service_id": "five9__configuration_service",
  "name": "Add to List",
  "description": "Add records to a Five9 contact list",
  "parameters": {
    "list_name": {
      "type": "string",
      "required": true,
      "description": "Name of the target contact list"
    }
  },
  "status": "active"
}

Each action’s parameters describe what a task must pass, and output_schema describes what it returns. This flow uses two actions: five9__configuration_service__create_list and five9__configuration_service__add_to_list.

Create a credential

A credential stores the secrets a task uses to reach an external platform. You supply the platform, the authentication method and the material — there is no service to pick, because one credential serves every compatible Five9 service:

curl -X POST "$BASE_URL/credentials" \
  -H "X-API-Key: $GETDIALED_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Five9 Production",
    "platform_id": "five9",
    "auth_method": "basic_auth",
    "credentials": {"username": "api_user@acme.com", "password": "REPLACE_ME"}
  }'

GetDialed verifies the material against Five9 and discovers which Five9 Domain it belongs to, so the create doubles as a liveness check — a 400 means the credentials could not be verified and nothing was stored. The response is the created credential; note its id:

{
  "id": "cred_e5f6g7h8",
  "name": "Five9 Production",
  "platform_id": "five9",
  "auth_method": "basic_auth",
  "tenancy_id": "ten_9f2c1a7b3d4e5f60",
  "tenant": {
    "id": "ten_9f2c1a7b3d4e5f60",
    "label": "Acme VCC",
    "platform_id": "five9",
    "is_manual": false
  },
  "status": "active"
}

You can re-check a saved credential at any time — after a rotation, for instance:

curl -X POST "$BASE_URL/credentials/cred_e5f6g7h8/test" \
  -H "X-API-Key: $GETDIALED_API_KEY"

A passing test returns {"success": true, ...} with the measured latency. A failing one returns success: false and an error code such as AUTH_FAILED — fix the credentials before continuing.

Author the definition

A flow definition declares inputs, then steps that run in order. Each step contains one or more tasks; every task names the catalog action it runs (platform_id, service_id, action_id) and the credential it runs with.This definition has two steps. Step 1 creates a Five9 list named after the trigger input. Step 2 adds a contact to it — and gets the list name from step 1’s output, not from the input:

curl -X POST "$BASE_URL/flows/definitions" \
  -H "X-API-Key: $GETDIALED_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Create list and add contact",
    "status": "active",
    "inputs": [
      {"name": "list_name", "type": "string", "required": true},
      {"name": "first_name", "type": "string", "required": true},
      {"name": "phone", "type": "string", "required": true}
    ],
    "steps": [
      {
        "step_id": "create_list",
        "name": "Create the contact list",
        "tasks": [
          {
            "task_id": "create_list_task",
            "task_name": "Create Five9 list",
            "platform_id": "five9",
            "service_id": "five9__configuration_service",
            "action_id": "five9__configuration_service__create_list",
            "connection_id": "cred_e5f6g7h8",
            "parameters": {
              "list_name": "{{input.list_name}}"
            }
          }
        ]
      },
      {
        "step_id": "add_contact",
        "name": "Add the contact to the new list",
        "tasks": [
          {
            "task_id": "add_contact_task",
            "task_name": "Add contact to Five9 list",
            "platform_id": "five9",
            "service_id": "five9__configuration_service",
            "action_id": "five9__configuration_service__add_to_list",
            "connection_id": "cred_e5f6g7h8",
            "parameters": {
              "list_name": "{{create_list.output.list_name}}",
              "first_name": "{{input.first_name}}",
              "number1": "{{input.phone}}"
            }
          }
        ]
      }
    ]
  }'

Two kinds of expression are doing the work here:

Expression	Resolves to
`{{input.list_name}}`	The `list_name` field of the trigger’s `input_data`
`{{create_list.output.list_name}}`	The `list_name` field of the `create_list` step’s output

Chaining follows the pattern {{<step_id>.<task_id>.output.<field>}}. When a step has exactly one task, the shorthand {{<step_id>.output.<field>}} also works — that’s what’s used above. See Expressions for the full context reference.Expressions are validated when you create or update a definition — a malformed one is rejected immediately with a 422 and an expression_errors list, so you never discover a typo at runtime.The response includes the new definition’s id (e.g. def_a1b2c3d4).

Activate it

Only definitions with "status": "active" can be triggered. The example above sets that at creation, so you’re done.If you’d rather iterate on a draft first, omit status (new definitions default to draft) and activate later with PUT /flows/definitions/{id} — a full replacement, so resend the whole body with "status": "active".

Trigger it

curl -X POST "$BASE_URL/flows/definitions/def_a1b2c3d4/trigger" \
  -H "X-API-Key: $GETDIALED_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "input_data": {
      "list_name": "July leads",
      "first_name": "Alice",
      "phone": "5551234567"
    }
  }'

{
  "job_id": "job_11223344",
  "definition_id": "def_a1b2c3d4",
  "status": "pending"
}

Every trigger creates a batch; this one carries a single input_data object, so it produces one execution. To fan the same flow out over many records at once, see Trigger with records.

Triggering a draft or archived definition returns 400 with "Cannot trigger definition with status 'draft'. Only active definitions can be triggered."

Inspect the results

Follow the batch until its status reaches completed:

curl "$BASE_URL/flows/batches/batch_11223344" \
  -H "X-API-Key: $GETDIALED_API_KEY"

Then list its executions and fetch the one execution’s full detail:

curl "$BASE_URL/flows/batches/batch_11223344/executions" \
  -H "X-API-Key: $GETDIALED_API_KEY"

curl "$BASE_URL/flows/executions/exec_aabbccdd" \
  -H "X-API-Key: $GETDIALED_API_KEY"

The execution’s result is keyed by step_id, so you can see exactly what each step produced — including the list_name that step 2 consumed:

{
  "id": "exec_aabbccdd",
  "batch_id": "batch_11223344",
  "status": "completed",
  "result": {
    "create_list": {
      "output": {"success": true, "list_name": "July leads"}
    },
    "add_contact": {
      "output": {"records_added": 1}
    }
  },
  "error": null
}

On failure, status is failed and error carries the message. See Batches and executions for the full lifecycle.

Next steps

Trigger with records

Run this flow once per row of a contact file.

Expressions

The full expression context: inputs, variables, step outputs, defaults.

Execution models

Run tasks immediately, on a schedule, in a time window, or on a signal.

Templates

Start from a pre-built definition instead of a blank page.

Getting Started

Core Concepts

Building Flows

Triggers & Streaming

Next steps

Trigger with records

Expressions

Execution models

Templates

​Next steps

Trigger with records

Expressions

Execution models

Templates

Next steps