Automation Rules
Authorizations
Path parameters
workspaceIdstringRequired
Query parameters
triggerstring · enumOptionalPossible values:
Rule trigger
enabledbooleanOptional
Rule enabled state
Responses
200
OK
application/json
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-06-22T18:47:31.422Z",
"updatedAt": "2025-06-22T18:47:31.422Z"
}
]
}
Authorizations
Path parameters
workspaceIdstringRequired
Body
namestring · min: 4Required
descriptionstringOptional
enabledbooleanOptional
categoryIdstring · uuidRequired
triggerstring · enumRequiredPossible values:
conditionsany ofRequired
or
Responses
201
OK
application/json
422
Invalid input
application/json
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-06-22T18:47:31.422Z",
"updatedAt": "2025-06-22T18:47:31.422Z"
}
Authorizations
Path parameters
workspaceIdstringRequired
Body
triggerstring · enumRequiredPossible values:
Responses
204
OK
404
Workspace, automation rule or category not found
application/json
422
Invalid input
application/json
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
Authorizations
Path parameters
workspaceIdstringRequired
automationRuleIdstring · uuidRequired
Rule ID
Responses
200
OK
application/json
404
Workspace or automation rule not found
application/json
409
Conflict while updating automation rule
application/json
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-06-22T18:47:31.422Z",
"updatedAt": "2025-06-22T18:47:31.422Z"
}
Authorizations
Path parameters
workspaceIdstringRequired
automationRuleIdstring · uuidRequired
Rule ID
Body
namestring | nullableOptional
descriptionstring | nullableOptional
enabledboolean | nullableOptional
triggerany ofOptional
string · enumOptionalPossible values:
string | nullableOptional
categoryIdstring · uuid | nullableOptional
conditionsany ofOptional
or
Responses
200
OK
application/json
404
Workspace or automation rule not found
application/json
422
Invalid input
application/json
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-06-22T18:47:31.422Z",
"updatedAt": "2025-06-22T18:47:31.422Z"
}
Authorizations
Path parameters
workspaceIdstringRequired
automationRuleIdstring · uuidRequired
Rule ID
Responses
204
OK
404
Workspace or automation rule not found
application/json
delete
DELETE /workspaces/{workspaceId}/inbox/automation/rules/{automationRuleId} HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
No content
Authorizations
Path parameters
workspaceIdstringRequired
Responses
200
OK
application/json
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-06-22T18:47:31.422Z",
"updatedAt": "2025-06-22T18:47:31.422Z"
}
]
}
Authorizations
Path parameters
workspaceIdstringRequired
Body
namestring · min: 4Required
Responses
201
OK
application/json
422
Invalid input
application/json
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-06-22T18:47:31.422Z",
"updatedAt": "2025-06-22T18:47:31.422Z"
}
Authorizations
Path parameters
workspaceIdstringRequired
Body
Responses
204
OK
404
Workspace, automation category not found
application/json
422
Invalid input
application/json
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
Authorizations
Path parameters
workspaceIdstringRequired
categoryIdstringRequired
Body
namestring · min: 4Required
Responses
200
OK
application/json
404
Workspace or automation category not found
application/json
409
Conflict while updating automation category
application/json
422
Invalid input
application/json
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-06-22T18:47:31.422Z",
"updatedAt": "2025-06-22T18:47:31.422Z"
}
Authorizations
Path parameters
workspaceIdstringRequired
categoryIdstringRequired
Responses
204
OK
404
Workspace or automation category not found
application/json
409
Conflict while deleting automation category
application/json
delete
DELETE /workspaces/{workspaceId}/inbox/automation/categories/{categoryId} HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
No content
Authorizations
Path parameters
workspaceIdstringRequired
Responses
200
OK
application/json
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"
}
Authorizations
Path parameters
workspaceIdstringRequired
Body
projectIdstring · uuid | nullableRequired
Responses
204
OK
409
Conflicting configuration updates
application/json
422
Invalid input
application/json
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?