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

# Superwall

> Connect Superwall and read paywall proceeds, MRR, charts, transactions, and campaigns

Connect Superwall to pull paywall metrics into Appeeky — REST, MCP, and the co-founder agent.

Use an **organization API key** from Superwall → Settings → API Keys (not a public SDK key). Appeeky stores it encrypted. Then attach Superwall apps to each Appeeky product, the same way you attach RevenueCat apps.

## How it works

1. Save your Superwall organization API key in Appeeky Settings, or via `POST /v1/connect/superwall/credentials`.
2. Attach the matching Superwall applications on the app dashboard.
3. Call metrics endpoints, MCP tools (`sw_*`), or ask the co-founder. They use the saved key — no Superwall key header.

## Credentials

| Method | Endpoint                                   | Description                               |
| ------ | ------------------------------------------ | ----------------------------------------- |
| POST   | `/v1/connect/superwall/credentials`        | Save and verify the organization API key  |
| GET    | `/v1/connect/superwall/credentials/status` | Connection status                         |
| DELETE | `/v1/connect/superwall/credentials`        | Disconnect Superwall                      |
| GET    | `/v1/connect/superwall/apps`               | List projects and applications in the org |

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl -X POST "https://api.appeeky.com/v1/connect/superwall/credentials" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"secretKey":"YOUR_SUPERWALL_ORG_KEY"}'
```

## Metrics

See [Superwall Metrics](/docs/superwall-metrics) for overview, dashboard, charts, transactions, and campaigns.

## MCP

After Superwall is connected, these tools use the saved key:

| Tool              | Description                                      |
| ----------------- | ------------------------------------------------ |
| `sw_apps`         | List Superwall projects and applications         |
| `sw_overview`     | Snapshot KPIs (proceeds, MRR, users, conversion) |
| `sw_dashboard`    | Stats + KPI charts + recent transactions         |
| `sw_chart`        | Time-series for a Superwall y-axis metric        |
| `sw_transactions` | Recent purchases, renewals, and trials           |
| `sw_campaigns`    | Campaigns and placements for an application      |

Full parameter reference: [MCP Server](/docs/mcp#sw_apps).

## Co-founder

When Superwall is connected and attached, briefings and chat can read paywall proceeds, MRR, charts, transactions, and campaigns. Campaign and paywall edits stay in the Superwall dashboard.

## Related

* [Superwall Metrics](/docs/superwall-metrics)
* [RevenueCat Overview](/docs/revenuecat-overview)
* [MCP Server](/docs/mcp)