Index

PlaylogiQ Developer Documentation

Welcome to the PlaylogiQ CRM Gamification Hub developer documentation.

What is PlaylogiQ?

PlaylogiQ is an enterprise-grade, multi-tenant CRM + Gamification Platform built specifically for the iGaming industry. It enables operators to:

  • Manage players with a 360° view of their activity
  • Run omnichannel campaigns via Email, SMS, Telegram, Push, In-app
  • Gamify the player experience with missions, badges, tournaments, and leaderboard
  • Segment players dynamically using real-time behavioral data
  • Track everything via a comprehensive real-time analytics dashboard

Quick Start

1. Install the SDK

npm install @playlogiq/sdk
# or
pnpm add @playlogiq/sdk

2. Initialize

import { PlaylogiQ } from '@playlogiq/sdk'
 
const plq = new PlaylogiQ({
  apiKey: 'plq_your_api_key',
  tenantId: 'your-tenant-id',
  // baseUrl defaults to https://api.playlogiq.com
})

3. Identify a player

await plq.identify({
  playerId: 'player-123',        // your internal player id (external_id)
  email: 'player@example.com',
  language: 'en',
  currency: 'EUR',
  traits: { vipTier: 'gold' },
})

4. Track a player event

await plq.track({
  playerId: 'player-123',
  event: 'player.deposit',
  payload: {
    amount: 100,
    currency: 'EUR',
    method: 'card',
  },
})
 
// Or batch up to 100 events in one request:
await plq.trackBatch({
  events: [
    { playerId: 'p1', event: 'player.login' },
    { playerId: 'p2', event: 'player.bet', payload: { amount: 5 } },
  ],
})

The SDK sends your API key in the x-api-key header automatically. For the full REST surface and the machine-readable OpenAPI spec, see the API Reference.

Architecture

See the Architecture Overview for a deep dive into the platform design.

API Reference

See the API Reference for the full REST API documentation.

Architecture