Automation Rules

List inbox automation rules

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

Authorization

useraccessKey

Path parameters

workspaceId*string

Query parameters

Response

200

OK

Body

application/json

results*array of Rule (object)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/inbox/automation/rules', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "categoryId": "123e4567-e89b-12d3-a456-426614174000",
      "trigger": "feedItemCreated",
      "orderPosition": 0,
      "enabled": false,
      "conditions": {
        "all": [
          {
            "name": "text"
          }
        ]
      },
      "actions": [
        {
          "name": "text"
        }
      ],
      "createdAt": "2024-10-18T03:32:15.241Z",
      "updatedAt": "2024-10-18T03:32:15.241Z"
    }
  ]
}

Create automation rule

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

Authorization

useraccessKey

Path parameters

workspaceId*string

Body

application/json

name*string

descriptionstring

enabledboolean

categoryId*string (uuid)

trigger*RuleTrigger (enum)

feedItemCreatedfeedItemUpdatedmessageReceivedmessageSendagentStatusUpdatedrootItemClosedslaWarningslaBreachedrequiredSkillsUpdatedtagsAddedtagsRemovednoNewMessagesFor

triggerArgumentsobject

conditions*Conditions (any of)

objectobject

actions*array of Action-2 (object)

Response

201422

OK

Body

application/json

id*string (uuid)

name*string

descriptionstring

categoryId*string (uuid)

trigger*RuleTrigger (enum)

feedItemCreatedfeedItemUpdatedmessageReceivedmessageSendagentStatusUpdatedrootItemClosedslaWarningslaBreachedrequiredSkillsUpdatedtagsAddedtagsRemovednoNewMessagesFor

triggerArgumentsobject

orderPositionnumber

enabled*boolean

conditions*Conditions (any of)

objectobject

actionsarray of Action-2 (object)

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/inbox/automation/rules', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "categoryId": "123e4567-e89b-12d3-a456-426614174000",
      "trigger": "feedItemCreated",
      "conditions": {},
      "actions": [
        {
          "name": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

201422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "categoryId": "123e4567-e89b-12d3-a456-426614174000",
  "trigger": "feedItemCreated",
  "orderPosition": 0,
  "enabled": false,
  "conditions": {
    "all": [
      {
        "name": "text"
      }
    ]
  },
  "actions": [
    {
      "name": "text"
    }
  ],
  "createdAt": "2024-10-18T03:32:15.241Z",
  "updatedAt": "2024-10-18T03:32:15.241Z"
}

Reorder automation rule

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

Authorization

useraccessKey

Path parameters

workspaceId*string

Body

application/json

trigger*RuleTrigger (enum)

feedItemCreatedfeedItemUpdatedmessageReceivedmessageSendagentStatusUpdatedrootItemClosedslaWarningslaBreachedrequiredSkillsUpdatedtagsAddedtagsRemovednoNewMessagesFor

rules*array of object

Response

204404422

OK

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/inbox/automation/rules/reorder', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "trigger": "feedItemCreated",
      "rules": [
        {
          "ruleId": "123e4567-e89b-12d3-a456-426614174000",
          "newOrderPosition": 0
        }
      ]
    }),
});
const data = await response.json();

Response

404422

{
  "code": "text",
  "message": "text"
}

Get automation rule

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

Authorization

useraccessKey

Path parameters

workspaceId*string

automationRuleId*string (uuid)

Rule ID

Response

200404409

OK

Body

application/json

id*string (uuid)

name*string

descriptionstring

categoryId*string (uuid)

trigger*RuleTrigger (enum)

feedItemCreatedfeedItemUpdatedmessageReceivedmessageSendagentStatusUpdatedrootItemClosedslaWarningslaBreachedrequiredSkillsUpdatedtagsAddedtagsRemovednoNewMessagesFor

triggerArgumentsobject

orderPositionnumber

enabled*boolean

conditions*Conditions (any of)

objectobject

actionsarray of Action-2 (object)

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/inbox/automation/rules/{automationRuleId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404409

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "categoryId": "123e4567-e89b-12d3-a456-426614174000",
  "trigger": "feedItemCreated",
  "orderPosition": 0,
  "enabled": false,
  "conditions": {
    "all": [
      {
        "name": "text"
      }
    ]
  },
  "actions": [
    {
      "name": "text"
    }
  ],
  "createdAt": "2024-10-18T03:32:15.241Z",
  "updatedAt": "2024-10-18T03:32:15.241Z"
}

Update automation rule

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

Authorization

useraccessKey

Path parameters

workspaceId*string

automationRuleId*string (uuid)

Rule ID

Body

application/json

namenullable string

descriptionnullable string

enablednullable boolean

triggerany of

RuleTrigger (enum)nullable string

triggerArgumentsnullable object

categoryIdnullable string (uuid)

conditionsConditions (any of)

objectobject

actionsnullable array of Action-2 (object)

Response

200404422

OK

Body

application/json

id*string (uuid)

name*string

descriptionstring

categoryId*string (uuid)

trigger*RuleTrigger (enum)

feedItemCreatedfeedItemUpdatedmessageReceivedmessageSendagentStatusUpdatedrootItemClosedslaWarningslaBreachedrequiredSkillsUpdatedtagsAddedtagsRemovednoNewMessagesFor

triggerArgumentsobject

orderPositionnumber

enabled*boolean

conditions*Conditions (any of)

objectobject

actionsarray of Action-2 (object)

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/inbox/automation/rules/{automationRuleId}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200404422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "categoryId": "123e4567-e89b-12d3-a456-426614174000",
  "trigger": "feedItemCreated",
  "orderPosition": 0,
  "enabled": false,
  "conditions": {
    "all": [
      {
        "name": "text"
      }
    ]
  },
  "actions": [
    {
      "name": "text"
    }
  ],
  "createdAt": "2024-10-18T03:32:15.241Z",
  "updatedAt": "2024-10-18T03:32:15.241Z"
}

Delete automation rule

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

Authorization

useraccessKey

Path parameters

workspaceId*string

automationRuleId*string (uuid)

Rule ID

Response

204404

OK

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/inbox/automation/rules/{automationRuleId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

404

{
  "code": "text",
  "message": "text"
}

List inbox automation categories

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

Authorization

useraccessKey

Path parameters

workspaceId*string

Response

200

OK

Body

application/json

results*array of Category (object)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/inbox/automation/categories', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "orderPosition": 0,
      "createdAt": "2024-10-18T03:32:15.241Z",
      "updatedAt": "2024-10-18T03:32:15.241Z"
    }
  ]
}

Create automation category

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

Authorization

useraccessKey

Path parameters

workspaceId*string

Body

application/json

name*string

Response

201422

OK

Body

application/json

id*string (uuid)

name*string

orderPositionnumber

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/inbox/automation/categories', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

201422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "orderPosition": 0,
  "createdAt": "2024-10-18T03:32:15.241Z",
  "updatedAt": "2024-10-18T03:32:15.241Z"
}

Reorder automation categories

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

Authorization

useraccessKey

Path parameters

workspaceId*string

Body

application/json

categories*array of object

Response

204404422

OK

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/inbox/automation/categories/reorder', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "categories": [
        {
          "categoryId": "123e4567-e89b-12d3-a456-426614174000",
          "newOrderPosition": 0
        }
      ]
    }),
});
const data = await response.json();

Response

404422

{
  "code": "text",
  "message": "text"
}

Update automation category

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

Authorization

useraccessKey

Path parameters

workspaceId*string

categoryId*string

Body

application/json

name*string

Response

200404409422

OK

Body

application/json

id*string (uuid)

name*string

orderPositionnumber

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/inbox/automation/categories/{categoryId}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

200404409422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "orderPosition": 0,
  "createdAt": "2024-10-18T03:32:15.241Z",
  "updatedAt": "2024-10-18T03:32:15.241Z"
}

Delete automation category

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

Authorization

useraccessKey

Path parameters

workspaceId*string

categoryId*string

Response

204404409

OK

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/inbox/automation/categories/{categoryId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

404409

{
  "code": "text",
  "message": "text"
}

Get current new-item reply configuration.

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

Authorization

useraccessKey

Path parameters

workspaceId*string

Response

200

OK

Body

application/json

projectId*nullable string (uuid)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/inbox/automation/new-item-reply', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200

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

Update or create new-item reply configuration.

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

Authorization

useraccessKey

Path parameters

workspaceId*string

Body

application/json

projectId*nullable string (uuid)

Response

204409422

OK

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/inbox/automation/new-item-reply', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "projectId": "123e4567-e89b-12d3-a456-426614174000"
    }),
});
const data = await response.json();

Response

409422

{
  "code": "text",
  "message": "text"
}