Developer Quick Start
Teak brings players back to free-to-play games with rewardable push notifications, emails, and links. You integrate it with a platform SDK on the client, and connect your backend to the Teak Server API. This page walks through what an integration involves and points you to the right guide for your platform.
How a Teak Integration Works
Every Teak integration is the same six steps. Steps 1 through 5 run on the client, and your platform’s quickstart walks you through each one. Step 6 connects your backend to Teak:
-
Create your game in the Teak Dashboard. You get an app ID and an API key.
-
Install the SDK for your engine or platform so your game can talk to Teak.
-
Identify the player so Teak knows who’s playing and can target and reward them.
-
Ask for push permission so you can reach players when they’re not in the game.
-
Send a test notification to confirm the integration end to end.
-
Set up the Reward Endpoint so Teak can grant rewards through a server-to-server call when a player comes back.
After these six steps, the basic integration is complete. Your platform’s developer guide covers additional topics, including deep links, player properties, and local notifications.
Before You Start
Before you begin integrating Teak into your project, make sure you have:
-
A game project (iOS, Android, web, or Facebook).
-
The ability to test new builds on devices or simulators/emulators.
-
Access to logs (device console or Unity console) so you can review Teak’s debug output.
-
For push, the credentials your platform needs: the Apple push certificate for iOS, Firebase/FCM config for Android, or Amazon ADM for Fire devices. Lining up access early saves a mid-integration wall.
Choose Your SDK
Pick the SDK that matches how your game is built, then follow its quickstart.
Unity SDK Quickstart |
JavaScript SDK Quickstart |
iOS Native SDK |
Android Native SDK |
|
If your game is built in Unity, use the Unity SDK, it will set up and install the native SDKs for you. |
Server API
The Teak Server API connects your game’s backend with Teak, server to server:
-
Grant rewards with the Reward Endpoint (because players love free coins).
-
Trigger notifications from your server in response to game events, including scheduled and bulk sends.
-
Keep player data in sync: player properties, purchases, and email.
-
Manage preferences and privacy: opt-out categories, subscriptions, and player removal.
Most games start with the Reward Endpoint, then add the rest as they need it.