Create Automation

Create Automation

Create a new automation workflow for your project. An automation consists of a trigger event and one or more actions that execute when the trigger fires. The automation is created in an active state by default.

Basic Example

mutation CreateAutomation {
  createAutomation(
    input: {
      trigger: {
        type: TODO_CREATED
      }
      actions: [
        {
          type: ADD_TAG
          tagIds: ["tag_abc123"]
        }
      ]
    }
  ) {
    id
    isActive
    trigger {
      id
      type
    }
    actions {
      id
      type
    }
    createdAt
  }
}

Advanced Example

mutation CreateAutomationAdvanced {
  createAutomation(
    input: {
      trigger: {
        type: TODO_LIST_CHANGED
        todoListId: "list_abc123"
        tagIds: ["tag_456"]
        assigneeIds: ["user_789"]
        color: "#FF5733"
        conditionMode: ALL
      }
      actions: [
        {
          type: CHANGE_DUE_DATE
          duedIn: 7
        }
        {
          type: ADD_ASSIGNEE
          assigneeIds: ["user_101", "user_102"]
        }
        {
          type: SEND_EMAIL
          metadata: {
            email: {
              to: ["[email protected]"]
              from: "[email protected]"
              subject: "Record moved to In Progress"
              content: "<p>A record has been moved.</p>"
              cc: ["[email protected]"]
            }
          }
        }
        {
          type: CREATE_CHECKLIST
          metadata: {
            checklists: [
              {
                title: "Review Checklist"
                position: 1.0
                checklistItems: [
                  {
                    title: "Code review"
                    position: 1.0
                    duedIn: 3
                    assigneeIds: ["user_101"]
                  }
                  {
                    title: "QA testing"
                    position: 2.0
                    duedIn: 5
                  }
                ]
              }
            ]
          }
        }
        {
          type: MAKE_HTTP_REQUEST
          httpOption: {
            url: "https://api.example.com/webhook"
            method: POST
            contentType: APPLICATION_JSON
            body: "{\"event\": \"record_moved\"}"
            headers: [
              { key: "X-Custom-Header", value: "automation" }
            ]
            authorizationType: BEARER_TOKEN
            authorizationBearerToken: "your-token-here"
          }
        }
      ]
    }
  ) {
    id
    isActive
    trigger {
      id
      type
      color
      todoList {
        id
        title
      }
      tags {
        id
        title
      }
      assignees {
        id
        name
      }
      conditionMode
      schedule {
        type
        hour
        minute
        timezone
        nextExecutionAt
      }
    }
    actions {
      id
      type
      duedIn
      assigneeTriggerer
      tags {
        id
        title
      }
      assignees {
        id
        name
      }
      metadata {
        ... on AutomationActionMetadataSendEmail {
          email {
            subject
            to
            from
          }
        }
        ... on AutomationActionMetadataCreateChecklist {
          checklists {
            title
            checklistItems {
              title
              duedIn
            }
          }
        }
      }
      httpOption {
        url
        method
        contentType
      }
    }
    createdBy {
      id
      name
      email
    }
    createdAt
    updatedAt
  }
}

Input Parameters

CreateAutomationInput

CreateAutomationTriggerInput

CreateAutomationTriggerScheduleInput

AutomationTriggerMetadataInput

CreateAutomationActionInput

AutomationActionHttpOptionInput

AutomationActionMetadataInput

Response Fields

The mutation returns an Automation object.

Required Permissions

Only owners and admins of an active project can create automations.

Error Responses

Authentication Required

{
  "errors": [{
    "message": "You must be logged in",
    "extensions": {
      "code": "UNAUTHENTICATED"
    }
  }]
}

When: No valid authentication token is provided.

Unauthorized

{
  "errors": [{
    "message": "Unauthorized",
    "extensions": {
      "code": "UNAUTHORIZED"
    }
  }]
}

When: The authenticated user does not have OWNER or ADMIN access to the project, or the project is archived.

Project Not Found

{
  "errors": [{
    "message": "Project not found",
    "extensions": {
      "code": "PROJECT_NOT_FOUND"
    }
  }]
}

When: The project context is invalid or the project does not exist.

Important Notes

• Active by Default: New automations are created in an active state and will begin triggering immediately
• Project Scope: Automations are created within the current project context
• Scheduled Triggers: When using SCHEDULED trigger type, the schedule configuration is required and the automation will be scheduled automatically
• Due Date Triggers: DUE_DATE_EXPIRED triggers will automatically schedule monitoring jobs for existing records
• Conditional Automations: CONDITIONAL trigger types will pre-populate a cache for efficient evaluation
• Multiple Actions: You can attach multiple actions to a single trigger, and they will all execute when the trigger fires
• HTTP Actions: Use MAKE_HTTP_REQUEST action type with httpOption to call external APIs or webhooks