Introduction
Onward connects Platforms, Advertisers, and Users through interactive quest chains and reward experiences. This documentation explains the integration flows and publishes the supported REST contracts from the API's OpenAPI specification.
Integration models
Platform integration
Platforms embed quest chains in their product. They register or synchronize users, display active chains and progress, send platform-side events, and let users claim rewards. See the Platform integration guide.
Advertiser integration
Advertisers receive users traffic from a Platform; provide user ID to connect accounts in advertiser's contour with platforms' contours; report advertiser-side events such as sign-up, KYC, or deposit; may deliver rewards through webhooks.
See the Advertiser integration guide.
Core concepts
- A quest chain contains one or more ordered or independently completable tasks.
- A Platform owns the user-facing experience and identifies users with
platform_user_id. - An Advertiser supplies off-platform tasks and identifies connected accounts with
advertiser_user_id. - A Task Provider reports the event that satisfies a task.
- A Reward Provider delivers the reward after Onward confirms eligibility.
One organization can have more than one role depending on the quest chain configuration.
What you can build
- Display active quest chains and user progress.
- Guide a user from a Platform to an Advertiser and securely connect the two accounts.
- Track task-completing events from either integration.
- Deliver task and chain rewards.
- Receive real-time workflow notifications through webhooks.
Base URL and versioning
All production requests use HTTPS and versioned /v1 paths:
Code
The initial public API Reference contains the two approved contracts:
Descriptions of additional workflow steps in these guides provide integration context. Their full request and response contracts will appear in the API Reference after they are promoted to the public OpenAPI specification.
Next steps
- Read Authentication and store the credentials in your backend.
- Choose the Platform or Advertiser integration guide.
- Review the generated API Reference.