Skip to documentation
AdQuestDocs

Start here

Open dashboard
Get started
View as MarkdownPlain text for LLMsOpen in ClaudeAsk questions about this pageOpen in ChatGPTAsk questions about this page

Introduction

AdQuest puts quests inside your app. Your signed-in users complete short tasks, earn tokens and spend them on lotteries, without leaving your product or creating another account.

On this page

Start here

Most teams go from nothing to a working quest in an afternoon. Follow these four pages in order.

  1. Get your keysAsk the publisher for the public API key, the Secret Key and the Embed URL.
  2. Show your first questOne backend route and one React component. About 5 minutes.
  3. Prove completionsWhat each quest format needs before AdQuest pays the reward.
  4. Test and go liveWalk the full journey once before real users see it.

Not on React? The iframe quickstart does the same from any website or native app.

Quickstart: iframe or WebViewEmbed from any website or native app.

How it works

  1. A user signs in to your app, as they do today.

  2. Your backend asks AdQuest for a participant session for that user, using your Secret Key. AdQuest returns a short-lived participant token.

  3. Your frontend shows the AdQuest widget, or your own interface, with the participant token and your public API key.

  4. AdQuest checks each completion on its own servers and settles the reward. Your backend hears about it by webhook.

Your users never sign in to AdQuest. Your backend says who a user is, and AdQuest trusts that. Step through the whole exchange below.

User
Your app
Your backend
AdQuest
Step 1 of 9: Your user signs in, as today

AdQuest never asks your users to log in. Your own sign-in stays the single source of identity.

// nothing to build: keep your existing login

Choose how to show it

React & Next.jsThe ready-made widget. The fastest start.Hosted iframe & WebViewAny website, iOS, Android, React Native or Flutter.Headless JavaScriptYour own screens on the typed client.API onlyPlain HTTP from any server or client.

Go further

How AdQuest worksWho does what, and which credential lives where.Participant sessionsTokens, refresh, logout, language and country.WebhooksHear about completions and winners on your server.Tokens, lotteries & claimsBalances, entries and prize claims.Multi-step questsSeveral steps, one reward.Complete example: Next.jsSession route, widget and webhook in one app.

Look it up

API referenceEvery public route, with headers and payloads.SDK referenceEvery client method, component prop and error code.ErrorsWhat each error code means and what to check.Use the docs with AI agentsllms.txt, Markdown pages and a rules file.

Not writing code?

If you run the platform from the dashboard, setting it up, branding it and publishing quests, the publisher guide is written for you.

Publisher guideSet up your platform, brand it and publish quests. No code.

Something unclear, missing or wrong here? Tell us