Quick Start Guide
Welcome to Trialbee Developer documentation! This guide will help you choose the right integration approach and get started quickly.
Trialbee simplifies the integration of candidate enrollment features into study landing pages. We recommend using the Trialbee Self-assessment Widget for most implementations, as it provides a streamlined, pre-configured enrollment workflow with built-in best practices. For organizations requiring custom user experiences or specific branding requirements, the Candidate API offers flexible integration options for building tailored solutions.
Choosing Your Integration: Widget vs API
Trialbee offers two primary integration approaches. Use this comparison table to determine which option best fits your needs:
| Factor | Self-assessment Widget | Candidate API via proprietary backend |
|---|---|---|
| Implementation Speed (technical) | ⚡ Fast | |
| Technical Complexity | 🟢 Low - JavaScript snippet | 🟡 Medium - Full backend integration |
| Customization Level | 🎨 Limited - Minor styling, images, content and branding | 🎯 Full - Complete control over UX |
| Maintenance | 🤖 Automatic - Updates handled by Trialbee or study configuration inside Honey | 👨💻 Manual - You manage updates of frontend, and reconfiguration might have to be done in Honey |
| Development Resources | 📝 Minimal - Front-end developer | 👥 Moderate - Full-stack developer |
| Time to Market | 🚀 Immediate - Deploy same day | ⏱️ Longer - Custom development cycle |
| Branding Control | 🎨 Basic - Colors, fonts, logos | 🎭 Complete - Full brand experience |
| Data Flow Control | 📊 Standard - Trialbee manages flow | 🔄 Custom - You control all data handling until transmitted to Candidate API |
| Form Validation | ✅ Built-in - Pre-configured rules | ⚙️ Custom - Implement your own |
| Multi-language Support | 🌐 70+ languages - Pre-translated | 🗣️ Custom - Translate should be done as part of other web development |
| Analytics & Tracking | 📈 Basic - Standard events | 📊 Advanced - Custom tracking |
Decision Framework
Choose the Self-assessment Widget if you
- ✅ Need to launch quickly (within days)
- ✅ Have limited development resources
- ✅ Want automatic updates and maintenance
- ✅ Are satisfied with standard user experience
- ✅ Need multi-language support out of the box
- ✅ Prefer a proven, tested solution
Choose the Candidate API if you
- ✅ Require complete control over user experience
- ✅ Have specific branding requirements
- ✅ Need to integrate with existing systems (CRM, databases)
- ✅ Want custom eligibility logic
- ✅ Have dedicated development resources
- ✅ Need advanced analytics and tracking
- ✅ Are using form builders (Gravity Forms, etc.)
- ✅ Have existing data to import
Quick Implementation Paths
Widget Implementation
- Get your
studyIdandlocalefrom your Trialbee Project Manager - Add the widget script to your webpage
- Configure the widget trigger
- Test the integration
Next Step: Widget Integration Guide
API Implementation
- Get your API credentials from your Trialbee Project Manager
- Design your custom enrollment flow
- Implement form handling and validation
- Integrate with the Candidate API
- Test all scenarios and edge cases
Next Step: Candidate API Overview
Prerequisites
Before starting either integration, ensure you have:
- Study configured in Trialbee Honey platform
- API credentials or widget configuration from your Project Manager
- Landing page ready for integration
- SSL certificate installed on your domain
- Development environment set up for testing
Need Help Deciding?
If you're still unsure which approach to choose, consider these common scenarios:
| Scenario | Recommended Approach | Reason |
|---|---|---|
| First-time Trialbee user | Widget | Fastest path to success |
| Existing complex website | API | Better integration with existing systems |
| Multiple studies planned | Widget or API | Easier to manage multiple implementations |
| Heavy branding requirements | API | Complete design control |
| Form builder (WordPress/Gravity Forms) | API | Native form integration |
| Limited development team | Widget | Minimal technical requirements |
| Advanced analytics needs | API | Custom tracking capabilities |
Support
- 📧 Email: Contact your assigned Trialbee Project Manager
- 📚 Documentation: Browse the guides in this documentation
- 🐛 Issues: Report technical issues to your Project Manager
Ready to get started? Choose your path above and dive into the implementation guides!