Sections
Theme

Install with AI

Paste one prompt into your coding agent and it wires up the SDK, keys, and your first campaign

The fastest way to integrate Invitebase is to not do it yourself. The platform quickstart teaches any capable coding agent — Claude Code, Cursor, and similar tools — how to install the SDK, wire your keys, and stand up a first referral campaign in your codebase. You paste one prompt; the agent does the quickstart.

The prompt

Install Invitebase into my app using https://docs.invitebase.com/implementation/get-started/quickstart

What the agent does

The agent reads the quickstart instructions and works through the same steps as the manual platform guides, adapted to your project:

  1. Detects your platform — Web/JS, iOS/Swift, or Android/Kotlin — from the project layout and branches to the matching install path.
  2. Installs the SDK with your package manager (@invitebase/js via npm, InvitebaseSDK via SPM, com.invitebase:sdk via Gradle).
  3. Wires configure(key) at your app's entry point, reading the publishable key from your environment config (pk_test_… for development, pk_live_… for production) rather than hardcoding it.
  4. Adds identify(user) at your signup/login boundary and inbound-link handling where your platform needs it.
  5. Creates your first referral campaign — or, where it cannot reach your dashboard, leaves the exact API call or dashboard steps to run.
  6. Surfaces a referral link behind an "invite a friend" entry point in your app, using getReferralLink(campaignId).
  7. Self-verifies — confirms the project compiles and runs with the SDK wired in.

Ask the agent to update existing wiring without duplicating configuration when re-running the prompt.

What the agent will ask you for

  • Your test API keys — from Developers → API keys at dashboard.invitebase.com. Give agents test keys (pk_test_…/sk_test_…) only; flip to live keys yourself when you ship.
  • Campaign details — what should count as a referral and what the reward is, if it creates the campaign for you.

Using it with your agent

Any agent that can fetch a URL and edit your project works. With Claude Code, paste the prompt into a session opened at your project root. With Cursor, paste it into Agent mode. The platform quickstarts cover supported platforms and installation steps.

These docs are agent-readable too: every page is served as raw .md, and llms.txt indexes the SDK references and API for agents that want to go deeper than the quickstart.

The Invitebase MCP server is available at https://mcp.invitebase.com. Connect a compatible AI assistant to create campaigns and read referral state. Use test keys while building your integration.

MCP install: Claude

Use https://mcp.invitebase.com as the server URL. Open Claude's Customize → Connectors, choose Add custom connector, and paste the URL. Complete the authentication prompts to connect.

See Claude's remote MCP connector guide for plan availability and setup details.

MCP install: ChatGPT

Use https://mcp.invitebase.com as the server URL. Open ChatGPT's custom MCP setup, enter a name and the server URL, and configure authentication. Availability depends on your account and workspace settings.

Follow OpenAI's connection guide for the current setup flow.

Verify the install

Trust but verify. After the agent reports success:

Check the key handling

The publishable key should come from your environment config, not a string literal in source. Search for pk_test in the diff — it should appear in .env-style files only.

Run the app and watch the dashboard

Launch the app. The Get started checklist at dashboard.invitebase.com auto-detects each milestone as the backend observes it: SDK initialized, first identify, first referral link, first tracked event. If the SDK ping never arrives, the wiring is not live.

Complete the loop

Finish with the last two steps of your platform's quickstart: simulate the referred signup and qualifying event, and confirm the referral reaches validated in the dashboard.

Troubleshooting

SymptomWhat to do
The agent stalls or loopsRe-paste the prompt in a fresh session; ask the agent to inspect existing wiring before continuing.
Project type not detectedName it in the prompt: "…using https://docs.invitebase.com/implementation/get-started/quickstart. This is an Expo app." React Native/Expo and Flutter projects should point the agent at the matching platform guide as supplementary context.
SDK installed but no ping in the dashboardConfirm configure runs at startup and the key in your env is the pk_test_… from the right app.
The agent hardcoded a keyAsk it to move the key to your environment config — then roll the key in Developers → API keys if it was committed.

If the agent gets stuck, the manual platform guides cover the same ground step by step, and support@invitebase.com is happy to look at a transcript.

On this page