Create an automation rule

curl --request POST \
  --url https://{your-subdomain}.neetoform.com/api/external/v2/forms/{form_id}/automation_rules \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "automation_rule": {
    "name": "Email the sales team",
    "description": "New leads",
    "performer": "<string>",
    "execution_delay": {
      "value": 5,
      "unit": "minutes"
    },
    "events": [],
    "conditions": [
      {
        "field": "<string>",
        "verb": "<string>",
        "metadata": {}
      }
    ],
    "actions": [
      {
        "name": "<string>",
        "actionable_type": "<string>",
        "actionable_id": "<string>",
        "metadata": {}
      }
    ]
  }
}
'

const options = {
  method: 'POST',
  headers: {'X-Api-Key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    automation_rule: {
      name: 'Email the sales team',
      description: 'New leads',
      performer: '<string>',
      execution_delay: {value: 5, unit: 'minutes'},
      events: [],
      conditions: [{field: '<string>', verb: '<string>', metadata: {}}],
      actions: [
        {
          name: '<string>',
          actionable_type: '<string>',
          actionable_id: '<string>',
          metadata: {}
        }
      ]
    }
  })
};

fetch('https://{your-subdomain}.neetoform.com/api/external/v2/forms/{form_id}/automation_rules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{your-subdomain}.neetoform.com/api/external/v2/forms/{form_id}/automation_rules"

payload = { "automation_rule": {
        "name": "Email the sales team",
        "description": "New leads",
        "performer": "<string>",
        "execution_delay": {
            "value": 5,
            "unit": "minutes"
        },
        "events": [],
        "conditions": [
            {
                "field": "<string>",
                "verb": "<string>",
                "metadata": {}
            }
        ],
        "actions": [
            {
                "name": "<string>",
                "actionable_type": "<string>",
                "actionable_id": "<string>",
                "metadata": {}
            }
        ]
    } }
headers = {
    "X-Api-Key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "automation_rule": {
    "id": "0d4a5b8e-2f61-4b0c-8a3e-5f7c9e2d1a44",
    "name": "Email the sales team",
    "description": "New leads",
    "status": "enabled",
    "performer": "any",
    "display_order": 123,
    "disabled_reason": "<string>",
    "execution_delay": {
      "value": 5,
      "unit": "minutes"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "events": [
      "submission_created"
    ],
    "conditions": [
      {
        "id": "<string>",
        "field": "<string>",
        "kind": "record",
        "verb": "contains",
        "join_type": "and_operator",
        "metadata": {
          "value": "@example.com"
        }
      }
    ],
    "actions": [
      {
        "id": "<string>",
        "name": "email_to",
        "actionable_type": "<string>",
        "actionable_id": "<string>",
        "metadata": {
          "subject": "New lead",
          "body": "{{all-answers}}",
          "emails": [
            "sales@example.com"
          ]
        }
      }
    ]
  }
}

{
  "error": "param is missing or the value is empty: automation_rule"
}

{
  "error": "Form does not exist."
}

{
  "error": "name is required."
}

POST

forms

{form_id}

automation_rules

Create an automation rule

curl --request POST \
  --url https://{your-subdomain}.neetoform.com/api/external/v2/forms/{form_id}/automation_rules \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "automation_rule": {
    "name": "Email the sales team",
    "description": "New leads",
    "performer": "<string>",
    "execution_delay": {
      "value": 5,
      "unit": "minutes"
    },
    "events": [],
    "conditions": [
      {
        "field": "<string>",
        "verb": "<string>",
        "metadata": {}
      }
    ],
    "actions": [
      {
        "name": "<string>",
        "actionable_type": "<string>",
        "actionable_id": "<string>",
        "metadata": {}
      }
    ]
  }
}
'

const options = {
  method: 'POST',
  headers: {'X-Api-Key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    automation_rule: {
      name: 'Email the sales team',
      description: 'New leads',
      performer: '<string>',
      execution_delay: {value: 5, unit: 'minutes'},
      events: [],
      conditions: [{field: '<string>', verb: '<string>', metadata: {}}],
      actions: [
        {
          name: '<string>',
          actionable_type: '<string>',
          actionable_id: '<string>',
          metadata: {}
        }
      ]
    }
  })
};

fetch('https://{your-subdomain}.neetoform.com/api/external/v2/forms/{form_id}/automation_rules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{your-subdomain}.neetoform.com/api/external/v2/forms/{form_id}/automation_rules"

payload = { "automation_rule": {
        "name": "Email the sales team",
        "description": "New leads",
        "performer": "<string>",
        "execution_delay": {
            "value": 5,
            "unit": "minutes"
        },
        "events": [],
        "conditions": [
            {
                "field": "<string>",
                "verb": "<string>",
                "metadata": {}
            }
        ],
        "actions": [
            {
                "name": "<string>",
                "actionable_type": "<string>",
                "actionable_id": "<string>",
                "metadata": {}
            }
        ]
    } }
headers = {
    "X-Api-Key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "automation_rule": {
    "id": "0d4a5b8e-2f61-4b0c-8a3e-5f7c9e2d1a44",
    "name": "Email the sales team",
    "description": "New leads",
    "status": "enabled",
    "performer": "any",
    "display_order": 123,
    "disabled_reason": "<string>",
    "execution_delay": {
      "value": 5,
      "unit": "minutes"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "events": [
      "submission_created"
    ],
    "conditions": [
      {
        "id": "<string>",
        "field": "<string>",
        "kind": "record",
        "verb": "contains",
        "join_type": "and_operator",
        "metadata": {
          "value": "@example.com"
        }
      }
    ],
    "actions": [
      {
        "id": "<string>",
        "name": "email_to",
        "actionable_type": "<string>",
        "actionable_id": "<string>",
        "metadata": {
          "subject": "New lead",
          "body": "{{all-answers}}",
          "emails": [
            "sales@example.com"
          ]
        }
      }
    ]
  }
}

{
  "error": "param is missing or the value is empty: automation_rule"
}

{
  "error": "Form does not exist."
}

{
  "error": "name is required."
}

Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key

string

default:your-api-key

required

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

Path Parameters

form_id

string

required

Unique ID of the form. Refer to Getting the Form ID for detailed instructions.

Body

application/json

automation_rule

object

required

Hide child attributes

automation_rule.name

string

Name of the rule. Must be unique in the form, ignoring case. Required when creating a rule.

Example:

"Email the sales team"

automation_rule.description

string

Example:

"New leads"

automation_rule.status

enum<string>

Defaults to enabled.

Available options:

enabled,

disabled

automation_rule.performer

string

any (default), or the name of an organization role.

automation_rule.execution_delay

object | null

How long to wait after the event before the actions run.

Hide child attributes

automation_rule.execution_delay.value

integer

Required range: 1 <= x <= 15

Example:

5

automation_rule.execution_delay.unit

enum<string>

Available options:

minutes,

hours,

days

Example:

"minutes"

automation_rule.events

enum<string>[]

When the rule runs. When you send this on update, it replaces all current events.

Available options:

submission_created,

custom_field_updated

automation_rule.conditions

object[]

Conditions that must match. When you send this on update, it replaces all current conditions.

Hide child attributes

automation_rule.conditions.field

string

ID of a question or a custom field.

automation_rule.conditions.kind

enum<string>

Available options:

record,

custom_field

automation_rule.conditions.verb

string

See the verb values in the response.

automation_rule.conditions.join_type

enum<string>

Available options:

and_operator,

or_operator

automation_rule.conditions.metadata

object

automation_rule.actions

object[]

Actions to run. When you send this on update, it replaces all current actions. Header values are not returned when you read a rule, so send the header values again when you resend a send_to_api action.

Hide child attributes

automation_rule.actions.name

string

See the name values in the response.

automation_rule.actions.actionable_type

string

automation_rule.actions.actionable_id

string

automation_rule.actions.metadata

object

Response

Created - The automation rule was created

automation_rule

object

Hide child attributes

automation_rule.id

string

Example:

"0d4a5b8e-2f61-4b0c-8a3e-5f7c9e2d1a44"

automation_rule.name

string

Example:

"Email the sales team"

automation_rule.description

string | null

Example:

"New leads"

automation_rule.status

enum<string>

Available options:

enabled,

disabled

automation_rule.performer

string

any, or the name of an organization role.

Example:

"any"

automation_rule.display_order

integer

Position in the order in which rules run, starting from 1.

automation_rule.disabled_reason

string | null

automation_rule.execution_delay

object | null

How long to wait after the event before the actions run.

Hide child attributes

automation_rule.execution_delay.value

integer

Required range: 1 <= x <= 15

Example:

5

automation_rule.execution_delay.unit

enum<string>

Available options:

minutes,

hours,

days

Example:

"minutes"

automation_rule.created_at

string<date-time>

automation_rule.updated_at

string<date-time>

automation_rule.events

enum<string>[]

Available options:

submission_created,

custom_field_updated

automation_rule.conditions

object[]

Hide child attributes

automation_rule.conditions.id

string

automation_rule.conditions.field

string

ID of a question or a custom field.

automation_rule.conditions.kind

enum<string>

Available options:

record,

custom_field

automation_rule.conditions.verb

string

One of is, is_not, contains, does_not_contain, contains_any_of, contains_all_of, contains_none_of, starts_with, ends_with, any_of, none_of, less_than, greater_than, any_time, during, not_during, is_before or is_after.

Example:

"contains"

automation_rule.conditions.join_type

enum<string>

Available options:

and_operator,

or_operator

automation_rule.conditions.metadata

object

Holds value, or values (a list) for verbs that take many values. For choice questions, use option IDs.

Example:

{ "value": "@example.com" }

automation_rule.actions

object[]

Hide child attributes

automation_rule.actions.id

string

automation_rule.actions.name

string

One of email_to_responder, email_to_form_creator, email_to_all_members, email_to, sms_to_responder, sms_to, send_to_api or assign_field_value.

Example:

"email_to"

automation_rule.actions.actionable_type

string | null

Record for the *_to_responder actions, NeetoFieldsEngine::Field for assign_field_value. Otherwise empty.

automation_rule.actions.actionable_id

string | null

automation_rule.actions.metadata

object

Settings of the action.

Email actions: subject, body and, for email_to, emails. The body can use Liquid, for example {{all-answers}}.
SMS actions: body and, for sms_to, phone_numbers.
*_to_responder actions: value is the ID of the question that holds the responder's address or number.
send_to_api: endpoint, body (a JSON string), enable_custom_headers and custom_headers. Header values are never returned, only the keys.
assign_field_value: value.

Example:

{
  "subject": "New lead",
  "body": "{{all-answers}}",
  "emails": ["sales@example.com"]
}

Getting started

Forms

Questions

Conditional logic

Automation rules

Thank-you pages

Form settings

Message templates

Share

Submissions

Themes

Webhooks

Discount codes

Templates

Team members

Roles

Audit logs

IP restriction

Custom domains

API keys

API v1 (deprecated)

Create an automation rule

Headers

Path Parameters

Body

Response