Skip to main content

Quick Start Guide

Time-to-First-Hello-World

Discord: Under 3 minutes | API: Under 5 minutes

We've optimized the onboarding experience so you can see your first reward distributed in minutes, not days.

Get your loyalty program running in under 5 minutes.

Choose Your Platform​

PlatformTime to SetupBest For
Discord5 minutesGaming, developer, and general communities
TelegramComing SoonTrading, crypto, and international communities
Custom/API30+ minutesDevelopers building custom integrations

Discord Quick Start​

Step 1: Get Your Brand ID and Security Key (1 minute)​

  1. Visit partners.loyalteez.app
  2. Create your account or sign in
  3. Go to Settings → Account
  4. Copy your Brand ID (starts with 0x, 42 characters)
  5. Go to Settings → Security
  6. Copy your Security Key (long hex string)

Step 2: Add the Bot (1 minute)​

  1. Go to Integrations → Channels → Discord
  2. Click "Add Loyalteez Bot to Discord"
  3. Select your server and authorize

Step 3: Connect Your Server (30 seconds)​

In your Discord server, run:

/setup connect brand_id:0xYOUR_BRAND_ADDRESS security_key:YOUR_SECURITY_KEY

Step 4: Test It! (30 seconds)​

/daily

You should see a success message with your first LTZ reward!

You're Live! 🎉​

Your members can now:

  • /daily — Daily check-in rewards
  • /balance — Check their balance
  • /streak — View streak status
  • /perks — Browse perks
  • Say "gm" or "gn" — Automatic rewards

Next Steps:

Telegram Quick Start​

Coming Soon

The Telegram bot is in final testing. Documentation is available for preview, but the bot is not yet publicly available.

Step 1: Get Your Brand ID and Security Key (1 minute)​

  1. Visit partners.loyalteez.app
  2. Create your account or sign in
  3. Go to Settings → Account
  4. Copy your Brand ID (starts with 0x, 42 characters)
  5. Go to Settings → Security
  6. Copy your Security Key (long hex string)

Step 2: Add the Bot (1 minute)​

  1. Open your Telegram group
  2. Add the Loyalteez bot (search for the bot username)
  3. Make it an administrator

Step 3: Connect Your Group (30 seconds)​

Send this message:

/setup 0xYOUR_BRAND_ADDRESS YOUR_SECURITY_KEY

Step 4: Test It! (30 seconds)​

/daily

You should see a success message with your first LTZ reward!

You're Live! 🎉​

Your members can now:

  • /daily — Daily check-in rewards
  • /balance — Check their balance
  • /streak — View streak status
  • /perks — Browse perks
  • Say "gm" or "gn" — Automatic rewards

Next Steps:

Custom Integration​

For developers building custom integrations (games, apps, websites):

Prerequisites​

  • Brand ID from Partner Portal
  • Security Key (generate in Partner Portal → Settings → Security)
  • Basic HTTP knowledge

Quick Example​

curl -X POST https://api.loyalteez.app/loyalteez-api/manual-event \
  -H "Content-Type: application/json" \
  -H "X-Loyalteez-Brand-Id: 0xYourBrandId" \
  -H "X-Loyalteez-Signature: <HMAC-SHA256>" \
  -H "X-Loyalteez-Timestamp: 1705862400000" \
  -d '{
    "brandId": "0xYourBrandId",
    "eventType": "custom_action",
    "userEmail": "player_123@yourgame.loyalteez.app",
    "metadata": {
      "platform": "your_game"
    }
  }'

Full Guide:

Configuration Reference​

Key URLs​

ServiceURL
Partner Portalpartners.loyalteez.app
Event Handler APIapi.loyalteez.app/loyalteez-api/manual-event
Gas Relayerrelayer.loyalteez.app/relay
Perks Portalperks.loyalteez.app

Smart Contracts (Soneium Mainnet)​

ContractAddress
LTZ Token0x5242b6DB88A72752ac5a54cFe6A7DB8244d743c9
PerkNFT0x6ae30d6Dcf3e75456B6582b057f1Bf98A90F2CA0
PointsSale0x5269B83F6A4E31bEdFDf5329DC052FBb661e3c72

Troubleshooting​

Discord: Bot Not Responding​

  1. Check bot has permissions: /setup check
  2. Verify Brand ID is correct
  3. Ensure bot role is above managed roles

Telegram: /setup Failed​

  1. Verify bot is admin in the group
  2. Check Brand ID is correct (42 chars, starts with 0x)

Rewards Not Processing​

  1. Check event is enabled in Partner Portal
  2. Verify brand has LTZ balance
  3. Check cooldown hasn't been hit

Need Help?​

What's Next?​

For Community Admins​

For Developers​

Last updated on