Create workflow

curl --request POST \
  --url https://app.base44.com/api/apps/{app_id}/workflows \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "name": "Email me new signups",
  "definition": {
    "do": [],
    "document": {
      "dsl": "1.0.0",
      "name": "notify",
      "version": "1.0.0"
    }
  },
  "trigger": {
    "config": {
      "cron_expression": "0 9 * * *",
      "timezone": "UTC",
      "trigger_type": "scheduled"
    }
  },
  "description": "Sends an email whenever a User record is created.",
  "change_summary": "Initial version"
}
'

import requests

url = "https://app.base44.com/api/apps/{app_id}/workflows"

payload = {
    "name": "Email me new signups",
    "definition": {
        "do": [],
        "document": {
            "dsl": "1.0.0",
            "name": "notify",
            "version": "1.0.0"
        }
    },
    "trigger": { "config": {
            "cron_expression": "0 9 * * *",
            "timezone": "UTC",
            "trigger_type": "scheduled"
        } },
    "description": "Sends an email whenever a User record is created.",
    "change_summary": "Initial version"
}
headers = {
    "api_key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Email me new signups',
    definition: {do: [], document: {dsl: '1.0.0', name: 'notify', version: '1.0.0'}},
    trigger: {
      config: {cron_expression: '0 9 * * *', timezone: 'UTC', trigger_type: 'scheduled'}
    },
    description: 'Sends an email whenever a User record is created.',
    change_summary: 'Initial version'
  })
};

fetch('https://app.base44.com/api/apps/{app_id}/workflows', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.base44.com/api/apps/{app_id}/workflows",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Email me new signups',
    'definition' => [
        'do' => [
                
        ],
        'document' => [
                'dsl' => '1.0.0',
                'name' => 'notify',
                'version' => '1.0.0'
        ]
    ],
    'trigger' => [
        'config' => [
                'cron_expression' => '0 9 * * *',
                'timezone' => 'UTC',
                'trigger_type' => 'scheduled'
        ]
    ],
    'description' => 'Sends an email whenever a User record is created.',
    'change_summary' => 'Initial version'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "api_key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.base44.com/api/apps/{app_id}/workflows"

	payload := strings.NewReader("{\n  \"name\": \"Email me new signups\",\n  \"definition\": {\n    \"do\": [],\n    \"document\": {\n      \"dsl\": \"1.0.0\",\n      \"name\": \"notify\",\n      \"version\": \"1.0.0\"\n    }\n  },\n  \"trigger\": {\n    \"config\": {\n      \"cron_expression\": \"0 9 * * *\",\n      \"timezone\": \"UTC\",\n      \"trigger_type\": \"scheduled\"\n    }\n  },\n  \"description\": \"Sends an email whenever a User record is created.\",\n  \"change_summary\": \"Initial version\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("api_key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.base44.com/api/apps/{app_id}/workflows")
  .header("api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Email me new signups\",\n  \"definition\": {\n    \"do\": [],\n    \"document\": {\n      \"dsl\": \"1.0.0\",\n      \"name\": \"notify\",\n      \"version\": \"1.0.0\"\n    }\n  },\n  \"trigger\": {\n    \"config\": {\n      \"cron_expression\": \"0 9 * * *\",\n      \"timezone\": \"UTC\",\n      \"trigger_type\": \"scheduled\"\n    }\n  },\n  \"description\": \"Sends an email whenever a User record is created.\",\n  \"change_summary\": \"Initial version\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.base44.com/api/apps/{app_id}/workflows")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Email me new signups\",\n  \"definition\": {\n    \"do\": [],\n    \"document\": {\n      \"dsl\": \"1.0.0\",\n      \"name\": \"notify\",\n      \"version\": \"1.0.0\"\n    }\n  },\n  \"trigger\": {\n    \"config\": {\n      \"cron_expression\": \"0 9 * * *\",\n      \"timezone\": \"UTC\",\n      \"trigger_type\": \"scheduled\"\n    }\n  },\n  \"description\": \"Sends an email whenever a User record is created.\",\n  \"change_summary\": \"Initial version\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "68b1c0d4e7b91d003c45a1f2",
  "app_id": "6820f3a4e7b91d003c45a1f2",
  "name": "Email me new signups",
  "status": "active",
  "file_key": "email-me-new-signups",
  "description": "Sends an email whenever a User record is created.",
  "status_reason": "consecutive_failures",
  "current_version_id": "9f2c1a7b3e5d84f60c1b2a9e7d4f8c3b6a5e2d1f0c9b8a7e6d5c4b3a2f1e0d9c",
  "trigger": {
    "config": {
      "cron_expression": "0 9 * * *",
      "timezone": "UTC",
      "trigger_type": "scheduled"
    }
  },
  "app_type_context": {
    "app_type": "user_app"
  },
  "last_run_at": "2026-08-25T09:12:44Z",
  "last_run_status": "success",
  "consecutive_failures": 0,
  "total_runs": 48,
  "successful_runs": 44,
  "failed_runs": 3,
  "created_date": "2026-07-02T11:04:00Z",
  "updated_date": "2026-08-20T16:31:00Z",
  "created_by": "you@example.com",
  "definition": {
    "do": [],
    "document": {
      "dsl": "1.0.0",
      "name": "notify",
      "version": "1.0.0"
    }
  }
}

Workflows

Create workflow

This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.

Creates a workflow and starts it running.

The new workflow is active immediately, so a scheduled trigger begins firing on its schedule and an event trigger starts listening as soon as this returns. Create it, then call Toggle workflow status if you want it paused instead.

Names are unique per app across everything that is not archived. Reusing a name returns a 409, so update the existing workflow with Update workflow rather than creating a second one. Saving also writes a matching file into the app’s code, so the workflow shows up in the editor alongside everything else.

This endpoint is limited to 20 requests per minute.

A workflow is a definition plus a trigger. The definition is a CNCF Serverless Workflow v1.0 document describing the steps to run, and the trigger decides when they run. Both are free-form objects here, so check a definition with Validate a workflow definition before you save it.

The response includes fields beyond the ones documented here. Don’t rely on undocumented response fields, as they can change at any time. Send only the fields documented here. Other request fields are not supported and their behavior can change.

POST

api

apps

{app_id}

workflows

Create workflow

curl --request POST \
  --url https://app.base44.com/api/apps/{app_id}/workflows \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "name": "Email me new signups",
  "definition": {
    "do": [],
    "document": {
      "dsl": "1.0.0",
      "name": "notify",
      "version": "1.0.0"
    }
  },
  "trigger": {
    "config": {
      "cron_expression": "0 9 * * *",
      "timezone": "UTC",
      "trigger_type": "scheduled"
    }
  },
  "description": "Sends an email whenever a User record is created.",
  "change_summary": "Initial version"
}
'

import requests

url = "https://app.base44.com/api/apps/{app_id}/workflows"

payload = {
    "name": "Email me new signups",
    "definition": {
        "do": [],
        "document": {
            "dsl": "1.0.0",
            "name": "notify",
            "version": "1.0.0"
        }
    },
    "trigger": { "config": {
            "cron_expression": "0 9 * * *",
            "timezone": "UTC",
            "trigger_type": "scheduled"
        } },
    "description": "Sends an email whenever a User record is created.",
    "change_summary": "Initial version"
}
headers = {
    "api_key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Email me new signups',
    definition: {do: [], document: {dsl: '1.0.0', name: 'notify', version: '1.0.0'}},
    trigger: {
      config: {cron_expression: '0 9 * * *', timezone: 'UTC', trigger_type: 'scheduled'}
    },
    description: 'Sends an email whenever a User record is created.',
    change_summary: 'Initial version'
  })
};

fetch('https://app.base44.com/api/apps/{app_id}/workflows', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.base44.com/api/apps/{app_id}/workflows",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Email me new signups',
    'definition' => [
        'do' => [
                
        ],
        'document' => [
                'dsl' => '1.0.0',
                'name' => 'notify',
                'version' => '1.0.0'
        ]
    ],
    'trigger' => [
        'config' => [
                'cron_expression' => '0 9 * * *',
                'timezone' => 'UTC',
                'trigger_type' => 'scheduled'
        ]
    ],
    'description' => 'Sends an email whenever a User record is created.',
    'change_summary' => 'Initial version'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "api_key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.base44.com/api/apps/{app_id}/workflows"

	payload := strings.NewReader("{\n  \"name\": \"Email me new signups\",\n  \"definition\": {\n    \"do\": [],\n    \"document\": {\n      \"dsl\": \"1.0.0\",\n      \"name\": \"notify\",\n      \"version\": \"1.0.0\"\n    }\n  },\n  \"trigger\": {\n    \"config\": {\n      \"cron_expression\": \"0 9 * * *\",\n      \"timezone\": \"UTC\",\n      \"trigger_type\": \"scheduled\"\n    }\n  },\n  \"description\": \"Sends an email whenever a User record is created.\",\n  \"change_summary\": \"Initial version\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("api_key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.base44.com/api/apps/{app_id}/workflows")
  .header("api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Email me new signups\",\n  \"definition\": {\n    \"do\": [],\n    \"document\": {\n      \"dsl\": \"1.0.0\",\n      \"name\": \"notify\",\n      \"version\": \"1.0.0\"\n    }\n  },\n  \"trigger\": {\n    \"config\": {\n      \"cron_expression\": \"0 9 * * *\",\n      \"timezone\": \"UTC\",\n      \"trigger_type\": \"scheduled\"\n    }\n  },\n  \"description\": \"Sends an email whenever a User record is created.\",\n  \"change_summary\": \"Initial version\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.base44.com/api/apps/{app_id}/workflows")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Email me new signups\",\n  \"definition\": {\n    \"do\": [],\n    \"document\": {\n      \"dsl\": \"1.0.0\",\n      \"name\": \"notify\",\n      \"version\": \"1.0.0\"\n    }\n  },\n  \"trigger\": {\n    \"config\": {\n      \"cron_expression\": \"0 9 * * *\",\n      \"timezone\": \"UTC\",\n      \"trigger_type\": \"scheduled\"\n    }\n  },\n  \"description\": \"Sends an email whenever a User record is created.\",\n  \"change_summary\": \"Initial version\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "68b1c0d4e7b91d003c45a1f2",
  "app_id": "6820f3a4e7b91d003c45a1f2",
  "name": "Email me new signups",
  "status": "active",
  "file_key": "email-me-new-signups",
  "description": "Sends an email whenever a User record is created.",
  "status_reason": "consecutive_failures",
  "current_version_id": "9f2c1a7b3e5d84f60c1b2a9e7d4f8c3b6a5e2d1f0c9b8a7e6d5c4b3a2f1e0d9c",
  "trigger": {
    "config": {
      "cron_expression": "0 9 * * *",
      "timezone": "UTC",
      "trigger_type": "scheduled"
    }
  },
  "app_type_context": {
    "app_type": "user_app"
  },
  "last_run_at": "2026-08-25T09:12:44Z",
  "last_run_status": "success",
  "consecutive_failures": 0,
  "total_runs": 48,
  "successful_runs": 44,
  "failed_runs": 3,
  "created_date": "2026-07-02T11:04:00Z",
  "updated_date": "2026-08-20T16:31:00Z",
  "created_by": "you@example.com",
  "definition": {
    "do": [],
    "document": {
      "dsl": "1.0.0",
      "name": "notify",
      "version": "1.0.0"
    }
  }
}

Authorizations

api_key

string

header

required

Personal API key.

Path Parameters

app_id

string

required

ID of the app whose workflows you want to work with.

Body

application/json

name

string

required

Name for the workflow. Must be unique among the app's workflows that are not archived.

Example:

"Email me new signups"

definition

Definition · object

required

The steps to run, as a CNCF Serverless Workflow v1.0 document. Check it with Validate a workflow definition first.

Example:

{
  "do": [],
  "document": {
    "dsl": "1.0.0",
    "name": "notify",
    "version": "1.0.0"
  }
}

trigger

Trigger · object

required

What starts the workflow. The trigger goes inside config, whose trigger_type picks the kind and whose remaining fields configure it. Add a top-level condition to skip a dispatch unless a jq expression over the payload is truthy.

Example:

{
  "config": {
    "cron_expression": "0 9 * * *",
    "timezone": "UTC",
    "trigger_type": "scheduled"
  }
}

description

string | null

What the workflow is for, in your own words.

Example:

"Sends an email whenever a User record is created."

change_summary

string | null

Note describing this version, kept in the workflow's version history.

Example:

"Initial version"

Response

The created workflow.

string

required

ID of the workflow.

Example:

"68b1c0d4e7b91d003c45a1f2"

app_id

string

required

ID of the app the workflow belongs to.

Example:

"6820f3a4e7b91d003c45a1f2"

name

string

required

Name of the workflow.

Example:

"Email me new signups"

status

string

required

Whether the workflow runs: active, inactive, or archived.

Example:

"active"

file_key

string | null

Name of the workflow's file in the app's code. null on workflows saved before files were kept.

Example:

"email-me-new-signups"

description

string | null

What the workflow is for.

Example:

"Sends an email whenever a User record is created."

status_reason

string | null

Why Base44 stopped the workflow itself, as a fixed code: consecutive_failures, end_condition_reached, migration_activation_failed, or workflows_not_available. null when you set the status yourself.

Example:

"consecutive_failures"

current_version_id

string | null

Version the workflow runs today, as the SHA-256 hash of that definition. null until a definition is saved.

Example:

"9f2c1a7b3e5d84f60c1b2a9e7d4f8c3b6a5e2d1f0c9b8a7e6d5c4b3a2f1e0d9c"

trigger

Trigger · object

What starts the workflow. The trigger sits under config, keyed by trigger_type.

Example:

{
  "config": {
    "cron_expression": "0 9 * * *",
    "timezone": "UTC",
    "trigger_type": "scheduled"
  }
}

app_type_context

App Type Context · object | null

Which app surface the workflow was authored against.

Example:

{ "app_type": "user_app" }

last_run_at

string<date-time> | null

When the workflow last started running. null before its first run.

Example:

"2026-08-25T09:12:44Z"

last_run_status

string | null

How that run ended: success, failed, or cancelled. null before the first run. Note this is a different set of values from a run's own status, which reports completed rather than success.

Example:

"success"

consecutive_failures

integer

default:0

Runs that have failed in a row. Resets on the next success.

Example:

0

total_runs

integer

default:0

Runs the workflow has started, ever.

Example:

48

successful_runs

integer

default:0

Runs that finished successfully, ever.

Example:

44

failed_runs

integer

default:0

Runs that ended in an error, ever.

Example:

3

created_date

string<date-time> | null

When the workflow was created.

Example:

"2026-07-02T11:04:00Z"

updated_date

string<date-time> | null

When the workflow was last changed.

Example:

"2026-08-20T16:31:00Z"

created_by

string | null

Email of whoever created the workflow.

Example:

"you@example.com"

definition

Definition · object | null

The steps the workflow runs, as a CNCF Serverless Workflow v1.0 document. null when no version has been saved yet. Only this endpoint returns it; the list endpoint does not.

Example:

{
  "do": [],
  "document": {
    "dsl": "1.0.0",
    "name": "notify",
    "version": "1.0.0"
  }
}

⌘I

App Management API (Beta)

Entities API (Beta)

Virality API (Beta)

Workflows API (Beta)

Analytics API (Beta)

Google Ads API (Beta)

Monitoring API

Audit Logs API

Create workflow

Authorizations

Path Parameters

Body

Response