Bricqs Developer Documentation
Add gamified engagements, quizzes, spin wheels, polls, challenges, rewards, and leaderboards to any website or application. Engineers can jump straight into reference pages; technical PMs can use this section to compare integration paths before handing implementation to engineering.
Choose Your Integration Method
The simplest option. Drop a script tag and a div onto any website, WordPress, Shopify, static HTML, anything. Auto-resize, event callbacks, and zero configuration.
Maximum isolation. Embed a single iframe tag that works anywhere iframes are supported. Ideal for CMS platforms, email builders, or environments where script injection is restricted.
For React/Next.js apps. Install the SDK package, wrap your app with a provider, and render engagements with full TypeScript support, eligibility checks, and event callbacks.
Enterprise-grade. React hooks that return pure data, state, and action handlers, zero rendering. Build your own UI with your design system while Bricqs handles the backend logic.
Comparison
| Feature | Script Tag | iframe | React SDK | Headless |
|---|---|---|---|---|
| Setup complexity | 2 lines HTML | 1 tag | npm install | npm install |
| UI customization | Theme only | Theme only | Theme + CSS | Full control |
| Auto-resize | Yes | Manual | Yes | N/A |
| Event callbacks | Yes | PostMessage | Yes | Yes |
| Eligibility checks | No | No | Yes | Yes |
| Framework required | None | None | React 18+ | React 18+ |
| TypeScript support | No | No | Full | Full |
| Best for | Any website | CMS / email | React apps | Enterprise |