Post base workflow action

POST

base

{baseId}

workflow

{workflowId}

action

cURL

curl --request POST \
  --url http://127.0.0.1:3000/api/base/{baseId}/workflow/{workflowId}/action \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "parentNodeId": "<string>",
  "type": "sendEmail",
  "name": "<string>",
  "description": "<string>",
  "config": "<unknown>"
}
'

{
  "config": {
    "tableId": "<string>",
    "fields": {},
    "baseId": "<string>",
    "loopKey": {
      "resolvable": true,
      "type": "fact",
      "fact": "<string>",
      "path": "<string>",
      "keyStack": [
        "<string>"
      ],
      "params": {
        "pipes": [
          "uppercase"
        ]
      }
    },
    "_fieldsOrder": [
      "<string>"
    ]
  },
  "id": "<string>",
  "category": "action",
  "type": "createRecord",
  "name": "<string>",
  "description": "<string>",
  "testResult": {
    "createdTime": "<string>",
    "spent": 123,
    "inputRaw": "<unknown>",
    "outputRaw": "<unknown>",
    "inputVariables": {},
    "outputVariables": {},
    "errorMsg": "<string>"
  },
  "outputVariables": {},
  "inputVariables": {},
  "createdTime": "<string>",
  "lastModifiedTime": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

parentNodeId

string

required

witch node this the parent, if not provided, it is a root node

type

enum<string>

required

type of action

可用选项:

sendEmail,

createRecord,

updateRecord,

httpRequest,

getRecords,

aiGenerate,

script

name

string

name of the node

description

string

description of the node

config

any | null

node configuration

Response

201 - application/json

Successful created

config

object

required

显示子属性

config.tableId

string

required

config.fields

object

required

fields data in the record

显示子属性

config.fields.{key}

object

Option 1
Option 2
Option 3

显示子属性

config.fields.{key}.resolvable

enum<boolean>

required

Need be resolved to static values before running

可用选项:

true,

false

config.fields.{key}.type

enum<string>

required

可用选项:

literal

config.fields.{key}.value

any | null

Literal value

config.baseId

string

Once this parameter is passed in, the data will be requested as if it were from the creator themselves.

config.loopKey

object

An array variable to run the action for each item in the array.

显示子属性

config.loopKey.resolvable

enum<boolean>

required

Need be resolved to static values before running

可用选项:

true,

false

config.loopKey.type

enum<string>

required

可用选项:

fact

config.loopKey.fact

string

required

Fact name, actionId or triggerId

config.loopKey.path

string

json-path syntax

config.loopKey.keyStack

string[]

save select stack

config.loopKey.params

object

显示子属性

config.loopKey.params.pipes

enum<string>[]

Pipe functions to transform the fact value

可用选项:

uppercase,

lowercase,

capitalize,

trim,

length,

toString,

jsonStringify,

encodeUrlComponent

config._fieldsOrder

string[]

string

required

node id

category

enum<string>

required

可用选项:

action

type

enum<string>

required

This Action will activate when a record is created in a table.

可用选项:

createRecord

name

string

name of the node

description

string

description of the node

testResult

object

action test result

显示子属性

testResult.createdTime

string

required

testResult.spent

number

spent time

testResult.inputRaw

unknown

testResult.outputRaw

unknown

testResult.inputVariables

object

The variables snapshot when executed

testResult.outputVariables

object

The variables snapshot when executed

testResult.errorMsg

string

outputVariables

object

output variables

inputVariables

object

input variables

createdTime

string | null

created time

lastModifiedTime

string | null

last modified time

Post base workflow action duplicateduplicate a automation workflow action

⌘I

cURL

curl --request POST \
  --url http://127.0.0.1:3000/api/base/{baseId}/workflow/{workflowId}/action \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "parentNodeId": "<string>",
  "type": "sendEmail",
  "name": "<string>",
  "description": "<string>",
  "config": "<unknown>"
}
'

{
  "config": {
    "tableId": "<string>",
    "fields": {},
    "baseId": "<string>",
    "loopKey": {
      "resolvable": true,
      "type": "fact",
      "fact": "<string>",
      "path": "<string>",
      "keyStack": [
        "<string>"
      ],
      "params": {
        "pipes": [
          "uppercase"
        ]
      }
    },
    "_fieldsOrder": [
      "<string>"
    ]
  },
  "id": "<string>",
  "category": "action",
  "type": "createRecord",
  "name": "<string>",
  "description": "<string>",
  "testResult": {
    "createdTime": "<string>",
    "spent": 123,
    "inputRaw": "<unknown>",
    "outputRaw": "<unknown>",
    "inputVariables": {},
    "outputVariables": {},
    "errorMsg": "<string>"
  },
  "outputVariables": {},
  "inputVariables": {},
  "createdTime": "<string>",
  "lastModifiedTime": "<string>"
}

快速上手

API 列表

Post base workflow action

Authorizations

Body

Response