> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pwnbook.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Plane

> Sync Pwnbook tasks with Plane.so issues for teams that use Plane as their primary project management tool.

## Overview

[Plane](https://plane.so) is an open-source project management tool. The Pwnbook Plane integration allows tasks created in Pwnbook to be synced as issues in a Plane project, keeping your security work visible in your existing project management workflow.

<Warning>The Plane integration is currently in early access. Core sync functionality is available, but some features (such as bidirectional sync and real-time updates) are still in development.</Warning>

## Prerequisites

* A Plane account (Cloud or self-hosted)
* A Plane API key
* The workspace slug and project ID you want to sync with
* Admin or Owner access in Pwnbook to configure the integration

## Credentials required

| Field              | Description                                                                                            |
| ------------------ | ------------------------------------------------------------------------------------------------------ |
| **API Key**        | A Plane API key. Generate one in **Plane Profile Settings → API Tokens**.                              |
| **Workspace Slug** | The short identifier for your Plane workspace, visible in the URL: `app.plane.so/<workspace-slug>/...` |
| **Project ID**     | The UUID of the Plane project to sync tasks into. Found in **Project Settings → Members** or the URL.  |

## Setup

<Steps>
  <Step title="Generate a Plane API key">
    1. Log in to your Plane account.
    2. Click your profile picture → **Profile Settings**.
    3. Go to **API Tokens**.
    4. Click **Add API Token**.
    5. Give it a name (e.g., `pwnbook`) and an optional expiry date.
    6. Copy the generated token.
  </Step>

  <Step title="Find your workspace slug and project ID">
    **Workspace slug:** Visible in the Plane URL after you're logged in:

    ```
    https://app.plane.so/<workspace-slug>/projects/...
    ```

    **Project ID:** Go to the project in Plane, then open **Settings**. The project ID (UUID) is shown there, or you can copy it from the URL:

    ```
    https://app.plane.so/<workspace-slug>/projects/<project-id>/...
    ```
  </Step>

  <Step title="Configure the integration in Pwnbook">
    1. Go to **Organization Settings → Marketplace → Plane**.
    2. Click **Configure**.
    3. Enter your **API Key**, **Workspace Slug**, and **Project ID**.
    4. Click **Save & Test**.
  </Step>
</Steps>

## What gets synced

| Pwnbook          | Plane                                |
| ---------------- | ------------------------------------ |
| Task title       | Issue title                          |
| Task description | Issue description                    |
| Task status      | Issue state (mapped to Plane states) |
| Assignee         | Issue assignee (matched by email)    |
| Due date         | Issue due date                       |

When a task is created or updated in Pwnbook, the corresponding Plane issue is created or updated.

<Note>Pwnbook stores the Plane issue ID alongside each task to maintain the link. Changes made directly in Plane are not currently synced back to Pwnbook.</Note>

## Disconnecting

To remove the Plane integration:

1. Go to **Organization Settings → Marketplace → Plane**.
2. Click **Disconnect**.
3. Confirm.

Existing Plane issues created by the integration remain in Plane. The Pwnbook task records retain the Plane issue ID field but will no longer sync.