Creates a new automation for the specified project. | awork API

curl -X POST https://api.awork.com/api/v1/projects/projectId/automations \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "type": "task-created"
}'

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdOn": "2024-01-15T09:30:00Z",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedOn": "2024-01-15T09:30:00Z",
  "triggerId": "123e4567-e89b-12d3-a456-426614174000",
  "trigger": {
    "updatedOn": "2024-01-15T09:30:00Z",
    "type": "task-created",
    "values": [
      {
        "name": "name",
        "value": "Design"
      }
    ]
  },
  "enabled": true,
  "state": "string",
  "createdByProjectTemplate": false,
  "projectId": "123e4567-e89b-12d3-a456-426614174000",
  "projectTemplateId": "123e4567-e89b-12d3-a456-426614174000",
  "actions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "createdOn": "2024-01-15T09:30:00Z",
      "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
      "updatedOn": "2024-01-15T09:30:00Z",
      "type": "tag-add-task",
      "order": 2,
      "values": [
        {
          "name": "tag",
          "value": "Design"
        }
      ]
    }
  ],
  "workflowId": "123e4567-e89b-12d3-a456-426614174000",
  "createdByAutomationIdFromWorkflow": "123e4567-e89b-12d3-a456-426614174000",
  "failed": {
    "code": "not-found",
    "description": "There is no matching path for this URL.",
    "link": "https://developers.awork.com",
    "details": [
      "No project with the id '123' exists."
    ],
    "validationErrors": [
      {
        "property": "FirstName",
        "message": "FirstName is required."
      }
    ],
    "traceId": "a65ce5745df02af216715ff06661fb3a"
  }
}

Creates a new automation for the project with the specified id. The user needs to be the owner of the project or have ‘write’ permissions of the feature ‘project-master-data’ globally or in the project.

Subscription Level

This endpoint requires the Standard plan or higher.

Required Permissions

Any authenticated user.

Creates a new automation for the project with the specified id. The user needs to be the owner of the project or have 'write' permissions of the feature 'project-master-data' globally or in the project. <Note title="Subscription Level" icon="layer-group">This endpoint requires the `Standard` plan or higher.</Note> <Check title="Required Permissions" icon="key">Any authenticated user.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

projectIdstringRequiredformat: "uuid"

The id of the project.

Request

The model to create the automation.

typestringRequired>=1 character

The type of the trigger.

valueslist of objects or nullOptional

The values of the trigger.

Response

idstringformat: "uuid"

The id of the automation.

createdBystringformat: "uuid"

The id of the user who created the automation.

createdOndatetime

The date the automation was created.

updatedBystringformat: "uuid"

The id of the user who updated the automation.

updatedOndatetime

The date the automation was updated.

triggerIdstringformat: "uuid"

The id of the trigger which is related to the automation.

triggerobject

enabledbooleanRead-only

Whether the automation is enabled.

statestring or null

The state of the automation. See AutomationsService.DAL.Models.AutomationState for the possible values.

createdByProjectTemplateboolean

Whether the automation was created from an automation template of a project template.

projectIdstring or nullformat: "uuid"

The id of the project which is related to the automation.

projectTemplateIdstring or nullformat: "uuid"

The id of the project template which is related to the automation.

actionslist of objects or null

The actions which is related to the automation.

workflowIdstring or nullformat: "uuid"

The workflow this automation belongs to, if any.

createdByAutomationIdFromWorkflowstring or nullformat: "uuid"

The id of the workflow automation that served as the template for this automation.

failedobject

The API error response.

Errors

400

Bad Request Error