Appmixer · Schema

Appmixer Flow

A Flow represents an automation workflow in Appmixer, consisting of connected components that define integration logic between services.

AgenticAutomationEmbedded iPaaSIntegrationsLow-CodeWorkflows

Properties

Name	Type	Description
id	string	Unique identifier for the flow.
name	string	Human-readable name of the flow.
flow	object	Flow definition object containing the workflow graph and component configurations.
stage	string	Current execution state of the flow.
btime	string	Creation timestamp of the flow.
mtime	string	Last modification timestamp of the flow.
thumbnail	string	URL or data URI of the flow thumbnail image.
customFields	object	Custom metadata key-value pairs associated with the flow.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/api-evangelist/appmixer/blob/main/json-schema/flow.json",
  "title": "Appmixer Flow",
  "description": "A Flow represents an automation workflow in Appmixer, consisting of connected components that define integration logic between services.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the flow."
    },
    "name": {
      "type": "string",
      "description": "Human-readable name of the flow."
    },
    "flow": {
      "type": "object",
      "description": "Flow definition object containing the workflow graph and component configurations."
    },
    "stage": {
      "type": "string",
      "enum": ["running", "stopped"],
      "description": "Current execution state of the flow."
    },
    "btime": {
      "type": "string",
      "format": "date-time",
      "description": "Creation timestamp of the flow."
    },
    "mtime": {
      "type": "string",
      "format": "date-time",
      "description": "Last modification timestamp of the flow."
    },
    "thumbnail": {
      "type": "string",
      "description": "URL or data URI of the flow thumbnail image."
    },
    "customFields": {
      "type": "object",
      "description": "Custom metadata key-value pairs associated with the flow.",
      "additionalProperties": true
    }
  },
  "required": ["id"]
}