Skip to main content
Use Proofly through Corsair: one client, typed API calls, local DB sync. Auth is the X-Api-Key header on 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

2

Add the plugin

corsair.ts
With multiTenancy: true, scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.
3

Choose authentication

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.

Example API calls

List campaigns
campaigns.setEnabled
See the full list on the API page.

Query synced data

Synced entities support tenant.proofly.db.<entity>.search() and .list(): campaigns, users. See Database for filters and operators.

What’s next

API reference

Every proofly.api.* operation with input and output types.

Database

Synced entities, search filters, and operators.

Connect / OAuth

createLink, Hub delivery, and tenant connect flows.

Use with agents

Expose this plugin’s operations as MCP tools.