Documentation Index
Fetch the complete documentation index at: https://docs.withbenji.com/llms.txt
Use this file to discover all available pages before exploring further.
What is Benji Connect?
Benji Connect enables you to connect your members to reward loyalty partners, allowing them to earn and redeem rewards through your platform. There are two ways to integrate Benji Connect into your application:- Benji Hosted Connect — Connect users through Benji Hosted Connect (Benji-managed page; no embedded JavaScript required)
- Benji Connect SDK — Embed the same Connect experience as a modal in your app
Benji Hosted Connect
Benji Hosted Connect is a fully hosted solution where you redirect users to a Benji-managed page that handles the entire Connect flow (internally using the same patterns as the Benji Connect SDK). You integrate primarily via URLs, Pilot configuration, and APIs—not by embedding JavaScript. No frontend code changes are required. Best suited for:- Quick integrations without building your own Connect UI
- Server-side or campaign-driven links
- Multi-platform use of a single Benji Hosted Connect URL pattern
- Dedicated Benji Hosted Connect experiences and custom domains configured in Pilot
Benji Hosted Connect Introduction
Learn how to integrate with Benji Hosted Connect
Benji Connect SDK
The Benji Connect SDK is a JavaScript/TypeScript library you load from npm or script tag. It opens the Connect experience in a modal over your page and delivers callbacks to your code. With this solution you have full control over when and how the connection flow is triggered. Best suited for:- Native app integrations
- Web applications requiring seamless user experience
- Scenarios where you want the connection flow embedded in your UI
- Tight control over when the modal opens and how you handle events
Benji Connect SDK Introduction
Learn how to integrate with the Benji Connect SDK
Comparison
| Feature | Benji Hosted Connect | Benji Connect SDK |
|---|---|---|
| Integration | Redirect + APIs; optional query parameters | Embed the Benji Connect SDK; initialize with token |
| Customization | Benji Hosted Connect in Pilot | Embedded in your UI |
| User experience | Full-page Benji Hosted Connect entry | Inline modal |
| Best for | Email campaigns, dedicated partner pages | Native app integrations, web applications |
| Effort | Minimal | Requires frontend integration |
Integration checklist
Use this list when wiring Benji Hosted Connect, the Benji Connect SDK, and your backend.| Step | What to do | Where to read more |
|---|---|---|
| API access | Create a partner API key in Pilot | Developer |
| Token | POST Create Token with partnership_id, mode, and optional fields | Create Token, Modes |
| Benji Hosted Connect URL | Use connect_url + ?connect_token=<token>; configure Redirect URL and optional custom domain in Pilot | Benji Hosted Connect |
| Benji Connect SDK | Install package, initialize, call open(), handle callbacks | Introduction |
| Long-lived access | POST Exchange Token with the token from onSuccess within 15 minutes | Exchange Token |
| Async updates | Subscribe to webhooks for user and transaction lifecycle | Webhooks overview |