> ## 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.

# Proofly plugin

> Read Proofly campaigns, their notifications and stats, the leads a notification collected, the signed-in user and activity logs, and turn campaigns on or off.

Use **Proofly** through Corsair: one client, typed API calls, local DB sync.

Auth is the X-Api-Key header on [https://proofly.io/api](https://proofly.io/api); copy the key from proofly.io/developers while logged in. Free accounts get 10 requests a minute; core retries a 429. Proofly answers a failure with `{ ok: false, error }`, which the plugin throws.

Proofly's API has six routes and the plugin covers all of them:

* **Campaigns.** `campaigns.list` lists them (stored locally). `campaigns.setEnabled` turns one on or off. Proofly's own call is a flip, so the plugin reads the current state first and sends nothing when it already matches (`changed: false`).
* **Notifications.** `notifications.list` returns a campaign's notifications with their settings and impressions, hovers, clicks and leads. `notifications.getData` returns what a notification collected: what visitors typed (often an email), their IP, page and location. That data is not stored, and events log only counts.
* **Account.** `user.get` returns the user (stored without the pixel key) and `activity.list` the login activity (not stored; IPs are not logged).

**What you get:**

* 6 typed API operations
* 2 synced entities (`campaigns`, `users`) for fast `.search()` / `.list()`

## Setup

**1. Install**

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

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

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

```bash bun theme={null}
bun add corsair @corsair-dev/proofly 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 { proofly } from '@corsair-dev/proofly';

export const corsair = createCorsair({
	plugins: [
		proofly(),
	],
	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 Proofly API key before the first call: `pnpm corsair setup --plugin=proofly --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}
> proofly()
> ```
>
> 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: 'proofly',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**List campaigns**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.proofly.api.campaigns.list({});
```

**`campaigns.setEnabled`**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.proofly.api.campaigns.setEnabled({});
```

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

## Query synced data

Synced entities support `tenant.proofly.db.<entity>.search()` and `.list()`: `campaigns`, `users`.

See [Database](https://docs.corsair.dev/plugins/proofly/database.md) for filters and operators.

## What's next

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

> [card] [Database](https://docs.corsair.dev/plugins/proofly/database.md)
>
> Synced entities, search filters, and operators.

> [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.