Getting Started
Integrating Stacked into your application
Overview
Integrating Stacked into your application involves three main components working together:
- Server-Side Analytics - Track user events and build user snapshots
- Client-Side SDK - Display offers and completion progress
- Stacked Dashboard - Create offers and monitor performance
Integration Flow
Create Your Stacked Account
Set up your organization and get your API credentials.
- Sign up at Stacked Dashboard
- Create your organization
- View your client credentials and API key
Install Server-Side SDK
Install the appropriate analytics SDK for your backend.
npm install @pixels-online/pixels-analytics-node-sdkgo get gitlab.com/pixels-online-oss/pixels-analytics-go-sdkGuide Coming soon
Track User Events
Start sending user data to build profiles and enable targeting.
const instance = new PixelsAnalytics(options);
// Track essential events
instance.spendCurrency("user-123", {currency_id: "gold", currency_amount: 100});
instance.gainItem("user-123", {item_id: "sword_001", item_amount: 1});
instance.custom("custom_event", "user-123", {custom: "value"});Client Integration
Select the client SDK that fits your application, or implement direct API calls.
Create Your First Offer
Use the visual offer builder to create engaging rewards.
- Navigate to Offers in the Stacked Dashboard
- Click Create New Offer
- Configure:
- Surfacing Conditions - Who sees the offer
- Completion Requirements - How to complete it
- Rewards - What users receive
- Timing - Start/end dates and expiry
Test in Sandbox
Validate your integration before going live.
Testing Checklist:
- ✅ Events are being tracked correctly
- ✅ User snapshots are updating
- ✅ Offers appear for eligible users
- ✅ Completion conditions track progress
- ✅ Rewards are claimed successfully
- ✅ Real-time surfacing works (SSE)
- ✅ Webhooks (if used) are firing correctly
Deploy to Production
Launch your integration and start engaging users!
Pre-launch Checklist:
- 🔒 Switch to production API keys
- 🪝 Make sure webhooks are set up correctly
- 🎯 Plan your initial campaigns
- 📱 Test on all target platforms
Production URLs:
// Update your client configuration
const client = new OfferwallClient({
env: 'live', // Switch to production
// ... rest of config
});Need Help?
If you have questions or need assistance, please reach out to us:
- 📧 Email: support@pixels.xyz,
- 💬 GitLab: https://gitlab.com/pixels-online-oss
Stacked