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

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/workspaces/{workspaceId}/inbox/automation/rules' \
  --header 'Authorization: Bearer jwt'

200

200

{
  "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-03-31T11:40:44.476Z",
      "updatedAt": "2025-03-31T11:40:44.476Z"
    }
  ]
}

OK

Create automation rule

post

Authorizations

Path parameters

workspaceIdstringrequired

Body

namestring · min: 4required

descriptionstringoptional

enabledbooleanoptional

categoryIdstring · uuidrequired

triggerstring · enumrequired

Available options:

triggerArgumentsobjectoptional

conditionsany ofrequired

actionsobject[] · min: 1required

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/inbox/automation/rules' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
        }
      }
    ]
  }'

201

422

201

{
  "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-03-31T11:40:44.476Z",
  "updatedAt": "2025-03-31T11:40:44.476Z"
}

OK

Reorder automation rule

patch

Authorizations

Path parameters

workspaceIdstringrequired

Body

triggerstring · enumrequired

Available options:

rulesobject[] · min: 1 · max: 100required

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/workspaces/{workspaceId}/inbox/automation/rules/reorder' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "trigger": "feedItemCreated",
    "rules": [
      {
        "ruleId": "123e4567-e89b-12d3-a456-426614174000",
        "newCategoryId": "123e4567-e89b-12d3-a456-426614174000",
        "newOrderPosition": 1
      }
    ]
  }'

204

404

422

204

No body

OK

Get automation rule

get

Authorizations

Path parameters

workspaceIdstringrequired

automationRuleIdstring · uuidrequired

Rule ID

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/workspaces/{workspaceId}/inbox/automation/rules/{automationRuleId}' \
  --header 'Authorization: Bearer jwt'

200

404

409

200

{
  "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-03-31T11:40:44.476Z",
  "updatedAt": "2025-03-31T11:40:44.476Z"
}

OK

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

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/workspaces/{workspaceId}/inbox/automation/rules/{automationRuleId}' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
        }
      }
    ]
  }'

200

404

422

200

{
  "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-03-31T11:40:44.476Z",
  "updatedAt": "2025-03-31T11:40:44.476Z"
}

OK

Delete automation rule

delete

Authorizations

Path parameters

workspaceIdstringrequired

automationRuleIdstring · uuidrequired

Rule ID

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/workspaces/{workspaceId}/inbox/automation/rules/{automationRuleId}' \
  --header 'Authorization: Bearer jwt'

204

404

204

No body

OK

List inbox automation categories

get

Authorizations

Path parameters

workspaceIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/workspaces/{workspaceId}/inbox/automation/categories' \
  --header 'Authorization: Bearer jwt'

200

200

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "orderPosition": 1,
      "createdAt": "2025-03-31T11:40:44.476Z",
      "updatedAt": "2025-03-31T11:40:44.476Z"
    }
  ]
}

OK

Create automation category

post

Authorizations

Path parameters

workspaceIdstringrequired

Body

namestring · min: 4required

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/inbox/automation/categories' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text"
  }'

201

422

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "orderPosition": 1,
  "createdAt": "2025-03-31T11:40:44.476Z",
  "updatedAt": "2025-03-31T11:40:44.476Z"
}

OK

Reorder automation categories

patch

Authorizations

Path parameters

workspaceIdstringrequired

Body

categoriesobject[] · min: 1 · max: 100required

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/workspaces/{workspaceId}/inbox/automation/categories/reorder' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "categories": [
      {
        "categoryId": "123e4567-e89b-12d3-a456-426614174000",
        "newOrderPosition": 1
      }
    ]
  }'

204

404

422

204

No body

OK

Update automation category

patch

Authorizations

Path parameters

workspaceIdstringrequired

categoryIdstringrequired

Body

namestring · min: 4required

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/workspaces/{workspaceId}/inbox/automation/categories/{categoryId}' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text"
  }'

200

404

409

422

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "orderPosition": 1,
  "createdAt": "2025-03-31T11:40:44.476Z",
  "updatedAt": "2025-03-31T11:40:44.476Z"
}

OK

Delete automation category

delete

Authorizations

Path parameters

workspaceIdstringrequired

categoryIdstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/workspaces/{workspaceId}/inbox/automation/categories/{categoryId}' \
  --header 'Authorization: Bearer jwt'

204

404

409

204

No body

OK

Get current new-item reply configuration.

get

Authorizations

Path parameters

workspaceIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/workspaces/{workspaceId}/inbox/automation/new-item-reply' \
  --header 'Authorization: Bearer jwt'

200

200

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

OK

Update or create new-item reply configuration.

put

Authorizations

Path parameters

workspaceIdstringrequired

Body

projectIdstring · uuid | nullablerequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/workspaces/{workspaceId}/inbox/automation/new-item-reply' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "projectId": "123e4567-e89b-12d3-a456-426614174000"
  }'

204

409

422

204

No body

OK