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

# Penpot plugin

> Penpot is the open-source design tool. This plugin manages teams, projects and design files over the RPC API, creates file snapshots and share links, reads and writes comment threads, configures team webhooks, and lists and revokes the account's API access tokens.

Use **Penpot** through Corsair: one client, typed API calls, and incoming webhooks.

Authenticate with an access token generated under Account settings > API access tokens; the plugin sends it as `Authorization: Token <token>` and asks for plain JSON with `Accept: application/json` (without that header Penpot answers in transit format). Every operation is a single RPC: a POST to /api/rpc/command/\<name> on design.penpot.app. Self-hosted instances are not supported yet.
Penpot documents request schemas only, so output objects are kept loose; ids are UUIDs. The API reference lives at [https://design.penpot.app/api/\_doc](https://design.penpot.app/api/_doc) (auto-generated from source).
Webhook deliveries from Penpot carry no signature: Penpot posts the audit event itself (\{ id, name, type, props, profileId }, with a penpot/\<version> User-Agent). The plugin accepts deliveries on that shape; add your own check at the route if you need stronger guarantees.
The RPC surface has \~150 operations; this plugin covers the teams, projects, files (including snapshots and share links), comments, webhooks and access-token groups. Fonts, media objects, invitations, members, organizations and exports are documented by Penpot but not part of this plugin.

**What you get:**

* 31 typed API operations
* 1 incoming webhook event types

## Setup

**1. Install**

```bash npm theme={null}
npm install corsair @corsair-dev/penpot better-sqlite3
npm install --save-dev @types/better-sqlite3
```

```bash yarn theme={null}
yarn add corsair @corsair-dev/penpot better-sqlite3
yarn add --dev @types/better-sqlite3
```

```bash pnpm theme={null}
pnpm install corsair @corsair-dev/penpot better-sqlite3
pnpm install --save-dev @types/better-sqlite3
```

```bash bun theme={null}
bun add corsair @corsair-dev/penpot better-sqlite3
bun add --dev @types/better-sqlite3
```

**2. Add the plugin**

```ts corsair.ts theme={null}
import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { penpot } from '@corsair-dev/penpot';

export const corsair = createCorsair({
	plugins: [
		penpot(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});
```

With `multiTenancy: true`, scope calls with `corsair.withTenant(id)`. See [Quick start](https://docs.corsair.dev/quick-start.md) for KEK + Hub keys, and [Multi-tenancy](https://docs.corsair.dev/concepts/multi-tenancy.md) for account isolation.

**3. Choose authentication**

> [tab] API Key (Recommended)
>
> Store the Penpot API key before the first call: `pnpm corsair setup --plugin=penpot --tenant=acme api_key=<your-key>` (leave out `--tenant` without `multiTenancy`), or pass it as `key` in the plugin options. With Hub, each tenant enters their own key on the connect page. See [API key auth](https://docs.corsair.dev/concepts/api-key).
>
> ```ts theme={null}
> penpot()
> ```
>
> More: [API Key](https://docs.corsair.dev/concepts/api-key)

**4. Connect a tenant**

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see [Connect / OAuth](https://docs.corsair.dev/management/connect).

```ts theme={null}
const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'penpot',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**List all projects**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.penpot.api.projects.listAll({});
```

**Create a project**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.penpot.api.projects.create({ teamId: '5f2a1c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d', name: 'Website Redesign' });
```

See the full list on the [API](https://docs.corsair.dev/plugins/penpot/api.md) page.

## Webhooks

This plugin registers **1** webhook event type. Configure the provider to POST to your Corsair HTTP handler, then use `webhookHooks` on the plugin factory.

See [Webhooks](https://docs.corsair.dev/plugins/penpot/webhooks.md) for every event path and payload shape, and [Webhooks concept](https://docs.corsair.dev/concepts/webhooks.md) for routing.

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/penpot/api.md)
>
> Every `penpot.api.*` operation with input and output types.

> [card] [Webhooks](https://docs.corsair.dev/plugins/penpot/webhooks.md)
>
> Event paths, payloads, and `webhookHooks` examples.

> [card] [Connect / OAuth](https://docs.corsair.dev/management/connect)
>
> createLink, Hub delivery, and tenant connect flows.

> [card] [Use with agents](https://docs.corsair.dev/mcp-adapters/mcp-adapters)
>
> Expose this plugin's operations as MCP tools.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.