No-code docs
Resources

Automation Rules

List inbox automation rules

get

/workspaces/{workspaceId}/inbox/automation/rules

Authorizations
Path parameters
workspaceIdstringrequired
Query parameters
triggerstring · enum

Rule trigger

Options: feedItemCreated, feedItemUpdated, messageReceived, messageSend, agentStatusUpdated, rootItemClosed, slaWarning, slaBreached, requiredSkillsUpdated, tagsAdded, tagsRemoved, noNewMessagesFor
enabledboolean

Rule enabled state

Responses
curl -L \
  --url '/workspaces/{workspaceId}/inbox/automation/rules' \
  --header 'Authorization: Bearer jwt'
{
  "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"
            }
          }
        ]
      },
      "createdAt": "2025-02-28T06:59:19.999Z",
      "updatedAt": "2025-02-28T06:59:19.999Z",
      "actions": [
        {
          "name": "text",
          "value": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        }
      ]
    }
  ]
}

OK

Create automation rule

post

/workspaces/{workspaceId}/inbox/automation/rules

Authorizations
Path parameters
workspaceIdstringrequired
Body
namestring · min: 4required
descriptionstring
enabledboolean
categoryIdstring · uuidrequired
triggerstring · enumrequired
Options: feedItemCreated, feedItemUpdated, messageReceived, messageSend, agentStatusUpdated, rootItemClosed, slaWarning, slaBreached, requiredSkillsUpdated, tagsAdded, tagsRemoved, noNewMessagesFor
triggerArgumentsobject
conditionsany ofrequired
actionsobject[]required
Responses
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"
        }
      }
    ]
  }'
{
  "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"
        }
      }
    ]
  },
  "createdAt": "2025-02-28T06:59:19.999Z",
  "updatedAt": "2025-02-28T06:59:19.999Z",
  "actions": [
    {
      "name": "text",
      "value": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}

OK

Reorder automation rule

patch

/workspaces/{workspaceId}/inbox/automation/rules/reorder

Authorizations
Path parameters
workspaceIdstringrequired
Body
triggerstring · enumrequired
Options: feedItemCreated, feedItemUpdated, messageReceived, messageSend, agentStatusUpdated, rootItemClosed, slaWarning, slaBreached, requiredSkillsUpdated, tagsAdded, tagsRemoved, noNewMessagesFor
rulesobject[]required
Responses
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
      }
    ]
  }'
No body

OK

Get automation rule

get

/workspaces/{workspaceId}/inbox/automation/rules/{automationRuleId}

Authorizations
Path parameters
workspaceIdstringrequired
automationRuleIdstring · uuidrequired

Rule ID

Responses
curl -L \
  --url '/workspaces/{workspaceId}/inbox/automation/rules/{automationRuleId}' \
  --header 'Authorization: Bearer jwt'
{
  "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"
        }
      }
    ]
  },
  "createdAt": "2025-02-28T06:59:19.999Z",
  "updatedAt": "2025-02-28T06:59:19.999Z",
  "actions": [
    {
      "name": "text",
      "value": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}

OK

Update automation rule

patch

/workspaces/{workspaceId}/inbox/automation/rules/{automationRuleId}

Authorizations
Path parameters
workspaceIdstringrequired
automationRuleIdstring · uuidrequired

Rule ID

Body
namestring | nullable
descriptionstring | nullable
enabledboolean | nullable
triggerArgumentsobject | nullable
categoryIdstring · uuid | nullable
conditionsany of
actionsobject[] | nullable
triggerany of
Responses
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,
    "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"
        }
      }
    ],
    "trigger": "feedItemCreated"
  }'
{
  "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"
        }
      }
    ]
  },
  "createdAt": "2025-02-28T06:59:19.999Z",
  "updatedAt": "2025-02-28T06:59:19.999Z",
  "actions": [
    {
      "name": "text",
      "value": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}

OK

Delete automation rule

delete

/workspaces/{workspaceId}/inbox/automation/rules/{automationRuleId}

Authorizations
Path parameters
workspaceIdstringrequired
automationRuleIdstring · uuidrequired

Rule ID

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

OK

List inbox automation categories

get

/workspaces/{workspaceId}/inbox/automation/categories

Authorizations
Path parameters
workspaceIdstringrequired
Responses
curl -L \
  --url '/workspaces/{workspaceId}/inbox/automation/categories' \
  --header 'Authorization: Bearer jwt'
{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "orderPosition": 1,
      "createdAt": "2025-02-28T06:59:19.999Z",
      "updatedAt": "2025-02-28T06:59:19.999Z"
    }
  ]
}

OK

Create automation category

post

/workspaces/{workspaceId}/inbox/automation/categories

Authorizations
Path parameters
workspaceIdstringrequired
Body
namestring · min: 4required
Responses
curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/inbox/automation/categories' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text"
  }'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "orderPosition": 1,
  "createdAt": "2025-02-28T06:59:19.999Z",
  "updatedAt": "2025-02-28T06:59:19.999Z"
}

OK

Reorder automation categories

patch

/workspaces/{workspaceId}/inbox/automation/categories/reorder

Authorizations
Path parameters
workspaceIdstringrequired
Body
categoriesobject[]required
Responses
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
      }
    ]
  }'
No body

OK

Update automation category

patch

/workspaces/{workspaceId}/inbox/automation/categories/{categoryId}

Authorizations
Path parameters
workspaceIdstringrequired
categoryIdstringrequired
Body
namestring · min: 4required
Responses
curl -L \
  --request PATCH \
  --url '/workspaces/{workspaceId}/inbox/automation/categories/{categoryId}' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text"
  }'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "orderPosition": 1,
  "createdAt": "2025-02-28T06:59:19.999Z",
  "updatedAt": "2025-02-28T06:59:19.999Z"
}

OK

Delete automation category

delete

/workspaces/{workspaceId}/inbox/automation/categories/{categoryId}

Authorizations
Path parameters
workspaceIdstringrequired
categoryIdstringrequired
Responses
curl -L \
  --request DELETE \
  --url '/workspaces/{workspaceId}/inbox/automation/categories/{categoryId}' \
  --header 'Authorization: Bearer jwt'
No body

OK

Get current new-item reply configuration.

get

/workspaces/{workspaceId}/inbox/automation/new-item-reply

Authorizations
Path parameters
workspaceIdstringrequired
Responses
curl -L \
  --url '/workspaces/{workspaceId}/inbox/automation/new-item-reply' \
  --header 'Authorization: Bearer jwt'
{
  "projectId": "123e4567-e89b-12d3-a456-426614174000"
}

OK

Update or create new-item reply configuration.

put

/workspaces/{workspaceId}/inbox/automation/new-item-reply

Authorizations
Path parameters
workspaceIdstringrequired
Body
projectIdstring · uuid | nullablerequired
Responses
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"
  }'
No body

OK

Last updated

Was this helpful?