> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/plane.md).

# Plane

Integration with Plane for creating and updating work items, managing projects, posting comments, and reacting to work item and comment webhooks.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication        |
| --------- | --------------------- |
| Plane     | Personal Access Token |

#### Plane

Connect to Plane with a personal access token to create and update work items, manage projects, and post comments.

**Set up in Plane**

1. Prepare the Plane account or service that the workflow will access. Grant access to the required resources and operations.
2. **Personal Access Token:** Create a personal access token in Plane under Profile Settings > Personal Access Tokens > Add personal access token. It inherits your full workspace permissions and is sent as the X-API-Key header.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Plane**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field         | Required                 | What to enter                                                                                                                                                                                                                                                                          |
| --------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Personal Access Token | Yes                      | Create a personal access token in Plane under Profile Settings > Personal Access Tokens > Add personal access token. It inherits your full workspace permissions and is sent as the X-API-Key header. [Provider instructions](https://developers.plane.so/api-reference/introduction). |
| Workspace Slug        | Yes                      | The slug in your Plane workspace URL, e.g. for <https://app.plane.so/acme-corp> the slug is 'acme-corp'. Plane has no endpoint to list workspaces, so it must be entered directly.                                                                                                     |
| API Host              | Optional / as applicable | Plane API host. Leave the default for Plane Cloud, or enter your self-hosted instance's host, e.g. <https://plane.acme.com>.                                                                                                                                                           |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Plane** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Create Issue

Create a new work item in a Plane project, with optional priority, state, assignees, labels, and dates.

**Inputs**

| Field        | Type                      | Required | Description                                                                            |
| ------------ | ------------------------- | -------- | -------------------------------------------------------------------------------------- |
| Project      | select (string)           | Yes      | The project to create the issue in. Options load from the selected connection.         |
| Title        | string                    | Yes      | Short title of the issue.                                                              |
| Description  | textarea                  | No       | Longer description of the issue. Basic HTML is supported.                              |
| Priority     | select (string)           | No       | Issue priority. Available values: Urgent, High, Medium, Low, None.                     |
| State        | select (string)           | No       | Workflow state for the new issue. Options load from the selected connection.           |
| Assignees    | multiple\_select (string) | No       | Project members to assign. Options load from the selected connection.                  |
| Labels       | multiple\_select (string) | No       | Labels to attach. Options load from the selected connection.                           |
| Parent issue | select (string)           | No       | Make this a sub-issue of an existing issue. Options load from the selected connection. |
| Start date   | date                      | No       | When work is planned to start.                                                         |
| Due date     | date                      | No       | When the issue is due.                                                                 |

**Outputs**

| Field     | Type   | Description        |
| --------- | ------ | ------------------ |
| Work item | object | The created issue. |

#### Update Issue

Update an existing Plane work item: retitle it, move it to another state, change its priority, or adjust assignees, labels, and dates.

**Inputs**

| Field       | Type                      | Required | Description                                                                                            |
| ----------- | ------------------------- | -------- | ------------------------------------------------------------------------------------------------------ |
| Project     | select (string)           | Yes      | The project the issue belongs to. Options load from the selected connection.                           |
| Issue       | select (string)           | Yes      | The issue to update. Options load from the selected connection.                                        |
| Title       | string                    | No       | New title. Leave empty to keep the current one.                                                        |
| Description | textarea                  | No       | New description. Leave empty to keep the current one.                                                  |
| Priority    | select (string)           | No       | New priority. Available values: Urgent, High, Medium, Low, None.                                       |
| State       | select (string)           | No       | Move the issue to this workflow state. Options load from the selected connection.                      |
| Assignees   | multiple\_select (string) | No       | Replace the assignees with this set (project members only). Options load from the selected connection. |
| Labels      | multiple\_select (string) | No       | Replace the labels with this set. Options load from the selected connection.                           |
| Start date  | date                      | No       | New start date.                                                                                        |
| Due date    | date                      | No       | New due date.                                                                                          |

**Outputs**

| Field     | Type   | Description                 |
| --------- | ------ | --------------------------- |
| Work item | object | The issue after the update. |

#### List Issues

List the work items in a Plane project, sorted by creation time, update time, or priority.

**Inputs**

| Field                | Type            | Required | Description                                                                                                                                                                 |
| -------------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Project              | select (string) | Yes      | The project to list issues from. Options load from the selected connection.                                                                                                 |
| Sort by              | select (string) | No       | How to sort the results. Available values: Newest first, Oldest first, Recently updated first, Least recently updated first, Highest priority first, Lowest priority first. |
| Max issues           | integer         | No       | How many issues to return (up to 200). Minimum: 1. Maximum: 200. Default: 50.                                                                                               |
| Continue from cursor | string          | No       | Resume listing from a previous call's cursor.                                                                                                                               |

**Outputs**

| Field       | Type          | Description                                     |
| ----------- | ------------- | ----------------------------------------------- |
| Work items  | object\_array | The issues in the project.                      |
| Next cursor | string        | Cursor for the next page, if more issues exist. |
| Returned    | integer       | How many issues this call returned.             |

#### Get Issue

Fetch a single Plane work item by its id.

**Inputs**

| Field   | Type            | Required | Description                                                                  |
| ------- | --------------- | -------- | ---------------------------------------------------------------------------- |
| Project | select (string) | Yes      | The project the issue belongs to. Options load from the selected connection. |
| Issue   | select (string) | Yes      | The issue to fetch. Options load from the selected connection.               |

**Outputs**

| Field     | Type   | Description          |
| --------- | ------ | -------------------- |
| Work item | object | The requested issue. |

#### Add Comment to Issue

Post a comment on a Plane work item to share context with the team.

**Inputs**

| Field      | Type            | Required | Description                                                                                    |
| ---------- | --------------- | -------- | ---------------------------------------------------------------------------------------------- |
| Project    | select (string) | Yes      | The project the issue belongs to. Options load from the selected connection.                   |
| Issue      | select (string) | Yes      | The issue to comment on. Options load from the selected connection.                            |
| Comment    | textarea        | Yes      | The comment body. Basic HTML is supported.                                                     |
| Visibility | select (string) | No       | Who can see the comment. Available values: Internal (team only), External (visible to guests). |

**Outputs**

| Field   | Type   | Description          |
| ------- | ------ | -------------------- |
| Comment | object | The created comment. |

#### Create Project

Create a new project in your Plane workspace, with an optional description and project lead.

**Inputs**

| Field        | Type            | Required | Description                                                                         |
| ------------ | --------------- | -------- | ----------------------------------------------------------------------------------- |
| Name         | string          | Yes      | The project's display name. Letters, numbers, and spaces only.                      |
| Identifier   | string          | Yes      | Short prefix for issue numbers, e.g. 'PLAT' gives PLAT-1. Letters and numbers only. |
| Description  | textarea        | No       | What the project is for.                                                            |
| Project lead | select (string) | No       | Workspace member to set as project lead. Options load from the selected connection. |

**Outputs**

| Field   | Type   | Description          |
| ------- | ------ | -------------------- |
| Project | object | The created project. |

#### List Projects

List the projects in your Plane workspace.

**Inputs**

| Field                | Type    | Required | Description                                                                     |
| -------------------- | ------- | -------- | ------------------------------------------------------------------------------- |
| Max projects         | integer | No       | How many projects to return (up to 200). Minimum: 1. Maximum: 200. Default: 50. |
| Continue from cursor | string  | No       | Resume listing from a previous call's cursor.                                   |

**Outputs**

| Field       | Type          | Description                                       |
| ----------- | ------------- | ------------------------------------------------- |
| Projects    | object\_array | The projects in the workspace.                    |
| Next cursor | string        | Cursor for the next page, if more projects exist. |
| Returned    | integer       | How many projects this call returned.             |

### Triggers

A trigger starts a workflow when its configured event occurs. Configure the event and filters before enabling the trigger.

#### Issue Created

Starts when a work item is created in Plane.

In Plane, open Workspace Settings > Webhooks > Add webhook, paste the URL shown here, enable the Work Item events, then paste the generated secret into Webhook Secret.

**Configuration**

| Field          | Type            | Required | Description                                                                                                            |
| -------------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------- |
| Webhook Secret | secret          | Yes      | The secret Plane shows once when you create the webhook. Used to verify that deliveries really come from Plane.        |
| Project        | select (string) | No       | Only start for events in this project. Leave empty for the whole workspace. Options load from the selected connection. |

**Event inputs**

| Field      | Type   | Required | Description                                   |
| ---------- | ------ | -------- | --------------------------------------------- |
| Issue ID   | string | Yes      | UUID of the created work item.                |
| Project ID | string | No       | UUID of the project the issue was created in. |
| Title      | string | No       | Title of the created issue.                   |
| Priority   | string | No       | Priority of the created issue.                |
| Created at | string | No       | When Plane created the issue.                 |

**Outputs**

| Field      | Type   | Description                               |
| ---------- | ------ | ----------------------------------------- |
| Issue ID   | string | UUID of the created work item.            |
| Project ID | string | UUID of the project the issue belongs to. |
| Title      | string | Title of the created issue.               |
| Priority   | string | Priority of the created issue.            |
| Created at | string | When Plane created the issue.             |

#### Issue Updated

Starts when a work item changes in Plane.

In Plane, open Workspace Settings > Webhooks > Add webhook, paste the URL shown here, enable the Work Item events, then paste the generated secret into Webhook Secret.

**Configuration**

| Field          | Type            | Required | Description                                                                                                            |
| -------------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------- |
| Webhook Secret | secret          | Yes      | The secret Plane shows once when you create the webhook. Used to verify that deliveries really come from Plane.        |
| Project        | select (string) | No       | Only start for events in this project. Leave empty for the whole workspace. Options load from the selected connection. |

**Event inputs**

| Field           | Type   | Required | Description                                   |
| --------------- | ------ | -------- | --------------------------------------------- |
| Issue ID        | string | Yes      | UUID of the updated work item.                |
| Project ID      | string | No       | UUID of the project the issue belongs to.     |
| Title           | string | No       | Current title of the issue.                   |
| Previous values | object | No       | The changed fields' values before the update. |
| Updated at      | string | No       | When Plane applied the update.                |

**Outputs**

| Field           | Type          | Description                                   |
| --------------- | ------------- | --------------------------------------------- |
| Issue ID        | string        | UUID of the updated work item.                |
| Project ID      | string        | UUID of the project the issue belongs to.     |
| Title           | string        | Current title of the issue.                   |
| Changed fields  | string\_array | Names of the fields that changed.             |
| Previous values | object        | The changed fields' values before the update. |
| Updated at      | string        | When Plane applied the update.                |

#### Comment Added

Starts when a comment is added to a Plane work item.

In Plane, open Workspace Settings > Webhooks > Add webhook, paste the URL shown here, enable the Work Item Comment events, then paste the generated secret into Webhook Secret.

**Configuration**

| Field          | Type            | Required | Description                                                                                                            |
| -------------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------- |
| Webhook Secret | secret          | Yes      | The secret Plane shows once when you create the webhook. Used to verify that deliveries really come from Plane.        |
| Project        | select (string) | No       | Only start for events in this project. Leave empty for the whole workspace. Options load from the selected connection. |

**Event inputs**

| Field      | Type     | Required | Description                                  |
| ---------- | -------- | -------- | -------------------------------------------- |
| Comment ID | string   | Yes      | UUID of the new comment.                     |
| Issue ID   | string   | No       | UUID of the work item that was commented on. |
| Project ID | string   | No       | UUID of the project the issue belongs to.    |
| Comment    | textarea | No       | Body of the new comment.                     |
| Created at | string   | No       | When the comment was posted.                 |

**Outputs**

| Field      | Type   | Description                                  |
| ---------- | ------ | -------------------------------------------- |
| Comment ID | string | UUID of the new comment.                     |
| Issue ID   | string | UUID of the work item that was commented on. |
| Project ID | string | UUID of the project the issue belongs to.    |
| Comment    | string | Body of the new comment.                     |
| Created at | string | When the comment was posted.                 |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/plane.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
