Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -520,6 +520,10 @@ export default defineConfig({
},
],
},
{
text: "Plane Runner",
link: "/automations/plane-runner",
},
],
},
{
Expand Down
86 changes: 41 additions & 45 deletions docs/automations/custom-automations.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,65 +5,65 @@ description: Automate repetitive project tasks with trigger-based workflows. Set

# Custom automations <Badge type="tip" text="Business" />

Automations let you streamline your project management workflow by automatically performing actions based on specific triggers and conditions. This powerful feature eliminates repetitive manual tasks, ensures consistency in your processes, and helps your team maintain focus on high-value work by letting the system handle routine operations.
Custom automations let you streamline your project management workflow by automatically performing actions based on specific triggers and conditions. This powerful feature eliminates repetitive manual tasks, ensures consistency in your processes, and helps your team maintain focus on high-value work by letting the system handle routine operations.

Think of automations as your digital assistant that watches for specific events in your projects and responds according to rules you define. Whether it's updating work item statuses, assigning team members, adding labels, or posting comments, automations work behind the scenes to keep your projects moving smoothly.

![Create automations](https://media.docs.plane.so/automations/create-automation.webp#hero)

## What automations do
For built-in automations, see [Automations](/automations/overview).

## How custom automations work

Automations follow a simple but powerful logic: When [trigger] happens, if [conditions] are met, then perform [actions]. This trigger-condition-action framework allows you to create sophisticated workflows that adapt to your team's specific needs.

### Key components
Every custom automation has three components.

**Triggers** are events that start the automation. A single event fires the automation, which then evaluates conditions before executing actions.

- **Triggers**
Events that start the automation (work item created, updated, state changed, assignee changed, comment created)
| Trigger | Fires when… |
| ----------------- | ----------------------------------------------- |
| Work item created | A new work item is added to the project |
| Work item updated | Any property on a work item changes |
| State changed | A work item moves to a different workflow state |
| Assignee changed | A work item's assignee is added or removed |
| Comment created | Someone adds a comment to a work item |

- **Conditions**
Optional filters that must be met for the automation to proceed (specific state, type, label, assignee, creator, or priority)
**Conditions** are optional filters that must be satisfied for the automation to proceed. If you add multiple conditions, all of them must be met (AND logic).

- **Actions**
What the automation does when triggered (add comments, change properties)
| Condition | Filters on… |
| ---------- | ------------------------------------ |
| State | A specific workflow state |
| Type | A specific work item type |
| Label | One or more project labels |
| Assignees | Specific team members |
| Created by | The person who created the work item |
| Priority | A specific priority level |

You can create complex workflows by adding multiple conditions and multiple actions to a single trigger, giving you fine-grained control over when and how automations execute.
**Actions** are what the automation does when fired. Multiple actions execute in sequence.

| Action | What it does |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Add comment | Posts an automatic comment on the work item |
| Change property | Updates a work item property: state, priority, assignee, labels, start date, or due date |
| Run Script | Executes a [Plane Runner](/automations/plane-runner) script, giving you full programmatic control — call external APIs, create linked work items, enforce custom business logic, or anything else you can write in JavaScript or TypeScript |

## Set up automations

![Configure trigger and action](https://media.docs.plane.so/automations/configure-trigger-and-action.webp#hero)

1. Navigate to your Project Settings.

2. Select **Automations** on the left pane.
3. Click **Create automation** to start building your workflow.
- Give your automation a descriptive name and description.
- Save the configuration.
4. Click **Add trigger** in the trigger section.
5. Choose from available trigger types:
- Work item created
- Work item updated
- State changed
- Assignee changed
- Comment created

6. Click **Add condition** to specify when the automation should run. Select condition types such as:
- State (specific workflow status)
- Type (work item type)
- Label (project tags)
- Assignees (specific team members)
- Created by
- Priority

7. Click **Add action** to specify what the automation should do. Choose from available actions:
- Add comment
- Change property (State, Priority, Assignee, Labels, Start Date, Due Date)
1. Navigate to **Project Settings → Automations**.
2. In the **Custom automations** section, click **Create automation**.
3. Give your automation a descriptive name and an optional description, then save.
4. Click **Add trigger** and choose the event that should start the automation.
5. Optionally click **Add condition** to narrow when the automation runs. You can add multiple conditions — the automation only fires when all conditions are met.
6. Click **Add action** to define what happens. Choose from **Add comment**, **Change property**, or **Run Script** <Badge type="warning" text="Enterprise Grid" />. You can add multiple actions — they execute in sequence.
7. Click **Enable** in the top right corner to activate the automation.

::: tip
You can add multiple conditions to create more specific rules and multiple actions to perform several operations in sequence on a single trigger.
:::

8. Click **Enable** on the top right corner of the screen to to start turn on the automation on your project.

## Manage automations

![Manage automations](https://media.docs.plane.so/automations/manage-automations.webp#hero)
Expand Down Expand Up @@ -95,17 +95,13 @@ Toggle automations on or off as needed without deleting them. This is useful for

## Common use cases

- **State management**
Automatically transition work items between workflow states and update status when specific conditions are met.
**State management.** Automatically transition work items between workflow states when conditions are met — for example, move a work item to "In Review" when an assignee is added, or to "Done" when all sub-items are completed.

- **Team assignment and handoffs**
Automatically assign team members when work items reach specific stages, reassign work based on type or priority, and ensure proper handoffs between different teams or departments.
**Team assignment and handoffs.** Auto-assign team members when work items reach specific stages. Reassign work based on type or priority to ensure proper handoffs between teams.

- **Priority and categorization**
Auto-adjust work item priorities based on labels or assignees, apply consistent labeling across similar work item types, and maintain project organization through automated property updates.
**Priority and categorization.** Auto-adjust priorities based on labels or assignees. Apply consistent labeling across similar work item types to keep projects organized.

- **Communication and notifications**
Post automatic comments when work items are assigned or reassigned, add context when work items move between stages, and ensure stakeholders receive updates on critical changes.
**Communication.** Post automatic comments when work items are assigned, reassigned, or move between stages. This keeps stakeholders informed without requiring manual updates.

---

Expand Down
Loading
Loading