workflowAutomations

Creates a new automation for a workflow.

Changed on

<Note title="Subscription Level" icon="layer-group">This endpoint requires the Standard plan or higher.</Note>

<Check title="Required Permissions" icon="key">The user must be an admin or have project-manage-config:write permissions.</Check>

post/workflows/{workflowId}/automations

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/workflows/{workflowId}/automations
  • Auth: HTTP bearer

Path parameters

workflowIdstring uuid required

Request body

typestring required

The type of the trigger.

Response

OK

idstring uuid

The id of the automation.

createdBystring uuid

The id of the user who created the automation.

createdOnstring date-time

The date the automation was created.

updatedBystring uuid

The id of the user who updated the automation.

updatedOnstring date-time

The date the automation was updated.

triggerIdstring uuid

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

enabledboolean

Whether the automation is enabled.

statestring nullable

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 uuid nullable

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

projectTemplateIdstring uuid nullable

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

workflowIdstring uuid nullable

The workflow this automation belongs to, if any.

createdByAutomationIdFromWorkflowstring uuid nullable

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

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id PostWorkflowAutomation removed and replaced with workflowAutomations_PostWorkflowAutomation