Skip to main content

​
Integration Checklist

Use this comprehensive checklist to track your integration progress and ensure you’ve completed all necessary steps before going live.

​
Phase 1: Setup & Credentials

1

Obtain API Credentials

  • Received Partner API Key from Reach team
  • Received JWT Shared Secret
  • Received Partner ID
  • Stored credentials securely (env variables, secrets manager)
  • Confirmed which environment to use (sandbox vs production)
Contact support@embedreach.com if you haven’t received your credentials.
2

Environment Configuration

  • Set up development environment
  • Configured staging/test environment (optional)
  • Prepared production environment
  • HTTPS configured for production
  • Firewall/security rules allow API access

​
Phase 2: Authentication Implementation

1

Backend Token Generation

  • Created endpoint to generate JWT tokens
  • Implemented proper authentication checks
  • Added required JWT claims (tenantId, userId, email, name, exp)
  • Set appropriate token expiration (recommended: 1 hour)
  • Tested token generation successfully
  • Verified tokens don’t expire too quickly
  • Ensured JWT secret is never exposed to frontend
See Authentication Guide for implementation details.
2

Token Refresh Mechanism

  • Implemented token refresh logic
  • Handle token expiration gracefully
  • Test what happens when token expires during active session

​
Phase 3: UI Integration

1

Embed Reach Interface

  • Decided on integration method (iFrame or React)
  • Added Reach SDK to your application
  • Created container element for Reach UI
  • Implemented SDK initialization code
  • Configured correct environment (production/sandbox)
  • Selected default feature/product to display
  • Applied custom theming (if desired)
Choose your integration method:
2

Security Headers (if applicable)

  • Reviewed Content Security Policy (CSP) requirements
  • Added Reach domains to CSP if needed
  • Configured Cross-Origin policies
  • Tested iFrame loading with security headers enabled
3

UI Testing

  • Reach interface loads without errors
  • Navigation within Reach works correctly
  • Responsive design works on mobile/tablet
  • No console errors in browser
  • Tested on all target browsers

​
Phase 4: Tenant Management

1

Tenant Creation

  • Created API integration to sync tenants
  • Mapped internal business/customer IDs to externalId
  • Synced initial set of tenants
  • Verified tenant creation via API
  • Implemented real-time tenant creation (on new customer signup)
  • Set up tenant updates for profile changes
See Tenants API for details.
2

Tenant Configuration

  • Configured tenant settings (timezone, business hours, etc.)
  • Set up location data for multi-location tenants
  • Verified tenant data appears correctly in UI

​
Phase 5: Data Integration

1

Customer Data Sync

  • Reviewed data requirements with Reach team
  • Implemented customer creation sync
  • Implemented customer update sync
  • Set up batch import for historical customers
  • Tested customer data appears in Reach
  • Verified data updates reflect in real-time
See Data Sharing Guide for requirements.
2

Transaction/Order Data Sync (if applicable)

  • Determined appropriate transaction schema
  • Implemented transaction sync on creation
  • Synced historical transactions
  • Verified revenue data appears correctly
  • Tested ROAS calculations (if using Acquire)
3

Custom Resource Schemas (if needed)

  • Defined custom schema definitions
  • Created schema via API
  • Implemented data sync for custom resources
  • Verified custom data in segments/automations
See Custom Schemas for advanced use cases.

​
Phase 6: Attribution & Tracking

This phase is required for Acquire and recommended for Measure. Skip if you’re only using Engage or Reputation.
1

Attribution Snippet Implementation

  • Added Reach tracking snippet to relevant pages
  • Implemented createIdentification calls on form submissions
  • Tested visitor tracking works
  • Verified identifications are recorded
  • Confirmed UTM parameters are captured
  • Tested on all major user flows
See Attribution & Tracking for implementation.
2

Conversion Tracking

  • Identified key conversion events
  • Implemented tracking for each conversion type
  • Verified conversions appear in Reach
  • Tested attribution lookback window

​
Phase 7: Product-Specific Setup

Select the products you’re integrating:

​
Ad Campaign Setup Checklist

  • Reviewed Acquire user flow with team
  • Tested ad account connection (Google/Meta)
  • Verified campaign creation works
  • Confirmed budget allocation functions correctly
  • Tested metrics dashboard displays data
  • Validated ROAS calculations
  • Verified ad platform disconnection flow
See Acquire Guide.

​
Phase 8: Testing & QA

1

Functional Testing

  • All API endpoints respond correctly
  • UI loads and functions properly
  • Authentication works for different user types
  • Data syncs appear in real-time
  • Navigation between features works
  • Error states are handled gracefully
2

End-to-End User Flows

  • New tenant onboarding flow tested
  • Core product features tested (Acquire/Engage/etc.)
  • Data modifications sync correctly
  • User permissions work as expected
  • Logout/session expiry handled properly
3

Performance & Load Testing

  • Page load times are acceptable
  • API response times meet requirements
  • Large data syncs complete successfully
  • Concurrent users don’t cause issues
4

Security Testing

  • JWT tokens validated properly
  • Secrets not exposed in client code
  • Authorization checks work correctly
  • HTTPS enforced in production
  • CORS policies configured properly

​
Phase 9: Pre-Launch

1

Documentation & Training

  • Created internal documentation for team
  • Documented any custom implementations
  • Trained support team on Reach features
  • Prepared user-facing help articles (if needed)
2

Monitoring & Observability

  • Set up logging for API calls
  • Configured error tracking/alerts
  • Created dashboard for monitoring integration health
  • Tested alerting on failures
3

Go-Live Readiness

  • All checklist items above completed
  • Staging environment fully tested
  • Production environment configured
  • Rollback plan documented
  • Support escalation process defined
  • Reach team notified of go-live date

​
Phase 10: Launch & Monitor

1

Gradual Rollout (Recommended)

  • Deploy to production
  • Enable for small subset of users first
  • Monitor for errors or issues
  • Gather initial user feedback
  • Expand to larger user base
  • Complete rollout to all users
2

Post-Launch Monitoring

  • Monitor error rates
  • Track API usage and performance
  • Review user adoption metrics
  • Address any reported issues
  • Collect feedback for improvements

​
Getting Help

Technical Support

Contact our team for integration assistance

API Reference

Complete API documentation and examples

Code Samples

Working code examples for common tasks

Status Page

Monitor Reach platform status and uptime

​
Success Criteria

Your integration is ready for production when:
Authentication - Users can log in and access Reach without errors
Data Sync - Customer and transaction data flows correctly
Core Features - Key product features work as expected
Performance - Load times and API responses are acceptable
Monitoring - You can track integration health and errors
Congratulations on completing your Reach integration!