Create a rule (trigger + condition + actions)

POST

/api/v1/workspaces/{ws}/databases/{db}/automations

Parameters

Path Parameters

db

required

string

Request Body^required

Media typeapplication/json

object

name

required

string

>= 1 characters <= 100 characters

trigger

required

One of:

object

object

type

required

string

Allowed values: record_created

object

object

type

required

string

Allowed values: record_updated

field_id

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

object

object

type

required

string

Allowed values: record_linked

relation_field_id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

object

object

type

required

string

Allowed values: schedule

every

required

string

Allowed values: hour day week

at

string

/^\d{2}:\d{2}$/

weekday

integer

<= 6

object

object

type

required

string

Allowed values: webhook_received

condition

actions

required

Array

>= 1 items <= 10 items

One of:

object

object

require_approval

boolean

type

required

string

Allowed values: set_values

values

required

object

key

additional properties

object

object

require_approval

boolean

type

required

string

Allowed values: create_record

database_id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

values

object

key

additional properties

link_via_relation_field_id

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

object

object

require_approval

boolean

type

required

string

Allowed values: add_comment

body_template

required

string

>= 1 characters <= 2000 characters

object

object

require_approval

boolean

type

required

string

Allowed values: notify_user

user

required

string

>= 1 characters <= 100 characters

message

required

string

>= 1 characters <= 500 characters

object

object

require_approval

boolean

type

required

string

Allowed values: update_linked

relation_field_id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

values

required

object

key

additional properties

object

object

require_approval

boolean

type

required

string

Allowed values: send_slack_message

text

required

string

>= 1 characters <= 3000 characters

channel

string

>= 1 characters <= 200 characters

object

object

require_approval

boolean

type

required

string

Allowed values: send_webhook

url

required

string format: uri

<= 2000 characters

body_template

string

<= 10000 characters

headers

object

key

additional properties

Any of:

string

string

<= 1000 characters

object

object

__keep

required

boolean

object

object

require_approval

boolean

type

required

string

Allowed values: run_agent

agent

required

string

>= 1 characters <= 100 characters

prompt

string

<= 2000 characters

tool_scope

Array<string>

<= 3 items

Allowed values: read write admin

target

string

Allowed values: trigger_record

model

string

<= 100 characters

max_steps

integer

>= 1 <= 50

max_cost_cents

integer

<= 9007199254740991

dry_run

boolean

object

object

require_approval

boolean

type

required

string

Allowed values: send_email

connection_id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

to

required

string

>= 1 characters <= 500 characters

cc

string

<= 500 characters

reply_to

string

<= 200 characters

subject

required

string

>= 1 characters <= 200 characters

body_markdown

required

string

>= 1 characters <= 10000 characters

object

object

require_approval

boolean

type

required

string

Allowed values: http_request

method

required

string

Allowed values: GET POST PUT PATCH DELETE

url

required

string

>= 1 characters <= 2000 characters

headers

object

key

additional properties

string

<= 1000 characters

body_template

string

<= 10000 characters

connection_id

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

capture

Array<object>

<= 10 items

object

path

required

string

<= 200 characters

target_field_id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

enabled

boolean

default: true

approverId

string

Responses

201