API docs by Redocly

Flexli Engine API (Alpha)

Download OpenAPI specification:Download

Connectors

Create a Connector

Request Body schema: application/json
required
type
required
string (Type)
name
required
string (Name)
description
required
string (Description)
schema_version
required
integer (Schema Version)
Value: 1
required
object (ConnectorV1Config)
Array of objects (Events)
Array of objects (Actions)

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "name": "string",
  • "description": "string",
  • "schema_version": 1,
  • "config": {
    },
  • "events": [
    ],
  • "actions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "href": "string"
}

List Connectors

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Read a Connector

path Parameters
connector_id
required
string

Connector ID

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "string",
  • "schema_version": 0,
  • "version": 0,
  • "name": "string",
  • "description": "string",
  • "config": { },
  • "events": [
    ],
  • "actions": [
    ]
}

Delete a Connector

path Parameters
connector_id
required
string

Connector ID

Responses

Response samples

Content type
application/json
{
  • "id": "20554228-97b1-46ce-9236-a70dc58f8b6e",
  • "error_code": "ValidationError",
  • "description": "The request body failed validation.",
  • "details": {
    }
}

Workflows

Create a Workflow

Request Body schema: application/json
required
name
required
string (Name) [ 3 .. 60 ] characters ^[a-zA-Z0-9 ]+$
Description (string) or Description (null) (Description)
Default: null
schema_version
required
any (Schema Version)
Value: 1
enabled
boolean (Enabled)
Default: true
Timeout (integer) or Timeout (null) (Timeout)
Default: null
WorkflowV1CreateWorkflowOnError (object) or null
Default: null
Source (any) or WorkflowsV1CreateEventSource (object) or Source (null) (Source)
Default: null
required
Array of any or WorkflowsV1CreateAction (object) (Actions) [ 1 .. 100 ] items

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": null,
  • "schema_version": 1,
  • "enabled": true,
  • "timeout": null,
  • "on_error": null,
  • "source": null,
  • "actions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "href": "string"
}

List all Workflow Versions

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Read a Workflow Version

path Parameters
workflow_id
required
string

Workflow ID

version
required
number

Workflow Version

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": null,
  • "version": 0,
  • "schema_version": 0,
  • "is_release_version": true,
  • "enabled": true,
  • "source": null,
  • "actions": [
    ]
}

Delete a Workflow Version

path Parameters
workflow_id
required
string

Workflow ID

version
required
number

Workflow Version

Responses

Run Workflow

Directly Run a Workflow Version

path Parameters
workflow_id
required
string

Workflow ID

version
required
number

Workflow Version

Request Body schema: application/json
required
object (InitialState)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "string",
  • "href": "string"
}

Run History

List all Workflow Runs

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

List all Status Updates for a Workflow Run

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}