No-code docs
Resources

Automation Rules

List inbox automation rules

get
Authorizations
Path parameters
workspaceIdstringRequired
Query parameters
triggerstring · enumOptional

Rule trigger

Available options:
enabledbooleanOptional

Rule enabled state

Responses
application/json
objectOptional
get
GET /workspaces/{workspaceId}/inbox/automation/rules HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*
200

OK

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "categoryId": "123e4567-e89b-12d3-a456-426614174000",
      "trigger": "feedItemCreated",
      "triggerArguments": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "orderPosition": 1,
      "enabled": true,
      "conditions": {
        "all": [
          {
            "name": "text",
            "value": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          }
        ]
      },
      "actions": [
        {
          "name": "text",
          "value": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        }
      ],
      "createdAt": "2025-04-22T05:01:13.821Z",
      "updatedAt": "2025-04-22T05:01:13.821Z"
    }
  ]
}

Create automation rule

post
Authorizations
Path parameters
workspaceIdstringRequired
Body
namestring · min: 4Required
descriptionstringOptional
enabledbooleanOptional
categoryIdstring · uuidRequired
triggerstring · enumRequiredAvailable options:
triggerArgumentsobjectOptional
conditionsany ofRequired
actionsobject[] · min: 1Required
Responses
application/json
objectOptional
post
POST /workspaces/{workspaceId}/inbox/automation/rules HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 350

{
  "name": "text",
  "description": "text",
  "enabled": true,
  "categoryId": "123e4567-e89b-12d3-a456-426614174000",
  "trigger": "feedItemCreated",
  "triggerArguments": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "conditions": {
    "all": [
      {
        "name": "text",
        "value": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    ]
  },
  "actions": [
    {
      "name": "text",
      "value": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "categoryId": "123e4567-e89b-12d3-a456-426614174000",
  "trigger": "feedItemCreated",
  "triggerArguments": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "orderPosition": 1,
  "enabled": true,
  "conditions": {
    "all": [
      {
        "name": "text",
        "value": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    ]
  },
  "actions": [
    {
      "name": "text",
      "value": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "createdAt": "2025-04-22T05:01:13.821Z",
  "updatedAt": "2025-04-22T05:01:13.821Z"
}

Reorder automation rule

patch
Authorizations
Path parameters
workspaceIdstringRequired
Body
triggerstring · enumRequiredAvailable options:
rulesobject[] · min: 1 · max: 100Required
Responses
patch
PATCH /workspaces/{workspaceId}/inbox/automation/rules/reorder HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 165

{
  "trigger": "feedItemCreated",
  "rules": [
    {
      "ruleId": "123e4567-e89b-12d3-a456-426614174000",
      "newCategoryId": "123e4567-e89b-12d3-a456-426614174000",
      "newOrderPosition": 1
    }
  ]
}
No content

Get automation rule

get
Authorizations
Path parameters
workspaceIdstringRequired
automationRuleIdstring · uuidRequired

Rule ID

Responses
application/json
objectOptional
get
GET /workspaces/{workspaceId}/inbox/automation/rules/{automationRuleId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "categoryId": "123e4567-e89b-12d3-a456-426614174000",
  "trigger": "feedItemCreated",
  "triggerArguments": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "orderPosition": 1,
  "enabled": true,
  "conditions": {
    "all": [
      {
        "name": "text",
        "value": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    ]
  },
  "actions": [
    {
      "name": "text",
      "value": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "createdAt": "2025-04-22T05:01:13.821Z",
  "updatedAt": "2025-04-22T05:01:13.821Z"
}

Update automation rule

patch
Authorizations
Path parameters
workspaceIdstringRequired
automationRuleIdstring · uuidRequired

Rule ID

Body
namestring | nullableOptional
descriptionstring | nullableOptional
enabledboolean | nullableOptional
triggerany ofOptional
triggerArgumentsobject | nullableOptional
categoryIdstring · uuid | nullableOptional
conditionsany ofOptional
actionsobject[] | nullableOptional
Responses
application/json
objectOptional
patch
PATCH /workspaces/{workspaceId}/inbox/automation/rules/{automationRuleId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 350

{
  "name": "text",
  "description": "text",
  "enabled": true,
  "trigger": "feedItemCreated",
  "triggerArguments": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "categoryId": "123e4567-e89b-12d3-a456-426614174000",
  "conditions": {
    "all": [
      {
        "name": "text",
        "value": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    ]
  },
  "actions": [
    {
      "name": "text",
      "value": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "categoryId": "123e4567-e89b-12d3-a456-426614174000",
  "trigger": "feedItemCreated",
  "triggerArguments": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "orderPosition": 1,
  "enabled": true,
  "conditions": {
    "all": [
      {
        "name": "text",
        "value": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    ]
  },
  "actions": [
    {
      "name": "text",
      "value": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "createdAt": "2025-04-22T05:01:13.821Z",
  "updatedAt": "2025-04-22T05:01:13.821Z"
}

Delete automation rule

delete
Authorizations
Path parameters
workspaceIdstringRequired
automationRuleIdstring · uuidRequired

Rule ID

Responses
delete
DELETE /workspaces/{workspaceId}/inbox/automation/rules/{automationRuleId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

No content

List inbox automation categories

get
Authorizations
Path parameters
workspaceIdstringRequired
Responses
application/json
objectOptional
get
GET /workspaces/{workspaceId}/inbox/automation/categories HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*
200

OK

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "orderPosition": 1,
      "createdAt": "2025-04-22T05:01:13.821Z",
      "updatedAt": "2025-04-22T05:01:13.821Z"
    }
  ]
}

Create automation category

post
Authorizations
Path parameters
workspaceIdstringRequired
Body
namestring · min: 4Required
Responses
application/json
objectOptional
post
POST /workspaces/{workspaceId}/inbox/automation/categories HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "orderPosition": 1,
  "createdAt": "2025-04-22T05:01:13.821Z",
  "updatedAt": "2025-04-22T05:01:13.821Z"
}

Reorder automation categories

patch
Authorizations
Path parameters
workspaceIdstringRequired
Body
categoriesobject[] · min: 1 · max: 100Required
Responses
patch
PATCH /workspaces/{workspaceId}/inbox/automation/categories/reorder HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "categories": [
    {
      "categoryId": "123e4567-e89b-12d3-a456-426614174000",
      "newOrderPosition": 1
    }
  ]
}
No content

Update automation category

patch
Authorizations
Path parameters
workspaceIdstringRequired
categoryIdstringRequired
Body
namestring · min: 4Required
Responses
application/json
objectOptional
patch
PATCH /workspaces/{workspaceId}/inbox/automation/categories/{categoryId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "orderPosition": 1,
  "createdAt": "2025-04-22T05:01:13.821Z",
  "updatedAt": "2025-04-22T05:01:13.821Z"
}

Delete automation category

delete
Authorizations
Path parameters
workspaceIdstringRequired
categoryIdstringRequired
Responses
delete
DELETE /workspaces/{workspaceId}/inbox/automation/categories/{categoryId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

No content

Get current new-item reply configuration.

get
Authorizations
Path parameters
workspaceIdstringRequired
Responses
application/json
objectOptional
get
GET /workspaces/{workspaceId}/inbox/automation/new-item-reply HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*
200

OK

{
  "projectId": "123e4567-e89b-12d3-a456-426614174000"
}

Update or create new-item reply configuration.

put
Authorizations
Path parameters
workspaceIdstringRequired
Body
projectIdstring · uuid | nullableRequired
Responses
put
PUT /workspaces/{workspaceId}/inbox/automation/new-item-reply HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "projectId": "123e4567-e89b-12d3-a456-426614174000"
}
No content

Last updated

Was this helpful?