Skip to main content
POST
/
base
/
{baseId}
/
workflow
/
{workflowId}
/
action
shell
curl --request POST \
  --url https://app.teable.ai/api/base/%7BbaseId%7D/workflow/%7BworkflowId%7D/action \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"name":"string","description":"string","config":null,"parentNodeId":"string","type":"sendEmail"}'
{
  "name": "<string>",
  "description": "<string>",
  "config": {
    "baseId": "<string>",
    "tableId": "<string>",
    "loopKey": {
      "resolvable": true,
      "type": "fact",
      "path": "<string>",
      "keyStack": [
        "<string>"
      ],
      "params": {
        "pipes": [
          "uppercase"
        ]
      },
      "fact": "<string>"
    },
    "fields": {},
    "_fieldsOrder": [
      "<string>"
    ]
  },
  "id": "<string>",
  "category": "action",
  "testResult": {
    "spent": 123,
    "inputRaw": "<any>",
    "outputRaw": "<any>",
    "inputVariables": {},
    "outputVariables": {},
    "errorMsg": "<string>",
    "createdTime": "<string>"
  },
  "outputVariables": {},
  "inputVariables": {},
  "createdTime": "<string>",
  "lastModifiedTime": "<string>",
  "type": "createRecord"
}

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

Available options:
sendEmail,
createRecord,
updateRecord,
httpRequest,
getRecords,
aiGenerate,
script
​
name
string

name of the node

​
description
string

description of the node

​
config
any

node configuration

Response

201 - application/json

Successful created

  • Option 1
  • Option 2
  • Option 3
  • Option 4
  • Option 5
  • Option 6
  • Option 7
​
config
object
required
​
id
string
required

node id

​
category
enum<string>
required
Available options:
action
​
type
enum<string>
required

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

Available options:
createRecord
​
name
string

name of the node

​
description
string

description of the node

​
testResult
object

action test result

​
outputVariables
object

output variables

​
inputVariables
object

input variables

​
createdTime
string | null

created time

​
lastModifiedTime
string | null

last modified time