{ ok: false, error }, which the plugin throws.
Proofly’s API has six routes and the plugin covers all of them:
- Campaigns.
campaigns.listlists them (stored locally).campaigns.setEnabledturns 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.listreturns a campaign’s notifications with their settings and impressions, hovers, clicks and leads.notifications.getDatareturns 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.getreturns the user (stored without the pixel key) andactivity.listthe login activity (not stored; IPs are not logged).
- 6 typed API operations
- 2 synced entities (
campaigns,users) for fast.search()/.list()
Setup
1
Install
2
Add the plugin
corsair.ts
multiTenancy: true, scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.3
Choose authentication
- API Key (Recommended)
Store the Proofly API key before the first call: More: API Key
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.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 campaignscampaigns.setEnabled
Query synced data
Synced entities supporttenant.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.