Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion account/billing.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Billing
description: Learn how Trophy controls costs by charging based on monthly active users.
description: Understand Trophy's billing model based on monthly active users, view available plans, manage your subscription, and control gamification costs.
og:description: Learn how Trophy controls costs by charging based on monthly active users.
icon: gauge
---
Expand Down
2 changes: 1 addition & 1 deletion account/branding.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Branding
description: Configure your logo and brand colors used across features built with Trophy.
description: Configure your logo, brand colors, and visual styling so Trophy emails, push notifications, and UI components match your product brand.
og:description: Learn how Trophy tracks usage according to the number of users
that use your product.
icon: palette
Expand Down
2 changes: 1 addition & 1 deletion account/members.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Members
description: Give team members access to Trophy and manage your account settings.
description: Invite teammates to your Trophy account, manage their roles and permissions, and control who can edit metrics, achievements, and other settings.
og:description: Give team members access to Trophy and manage your account settings.
icon: user-plus
---
Expand Down
4 changes: 2 additions & 2 deletions account/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Overview
description: Learn how to manage your Trophy account.
title: Account overview
description: Manage your Trophy account, including team members, billing, branding, and account-level settings used across the Trophy platform.
---

From inviting team members to understanding billing, this section of the documentation is dedicated to managing your Trophy account.
Expand Down
5 changes: 2 additions & 3 deletions admin-api/authentication.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Authentication
description: Integrate securely with the API using account-level API keys
transmitted in the `X-API-KEY` header.
title: Admin API authentication
description: Authenticate Admin API requests using account-level API keys sent in the X-API-KEY header to manage Trophy configuration programmatically.
og:description: Integrate securely with the Trophy API using account-level API
keys transmitted in the `X-API-KEY` header.
icon: key
Expand Down
4 changes: 2 additions & 2 deletions admin-api/client-libraries.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: Client Libraries
description: Use Trophy's type-safe SDKs to integrate with the API.
title: Admin API client libraries
description: Install Trophy's type-safe SDKs for Node.js, Python, and other languages to integrate the Admin API and automate configuration workflows.
og:description: Use Trophy's type-safe SDKs to integrate with the API and start
building gamified product experiences.
icon: code-xml
---

The Trophy Admin API is available in the same SDKs as the [Application API](/api-reference/client-libraries), under the `trophy.admin` namespace.

Check warning on line 9 in admin-api/client-libraries.mdx

View check run for this annotation

Mintlify / Mintlify Validation (trophy) - vale-spellcheck

admin-api/client-libraries.mdx#L9

Did you really mean 'namespace'?

For example in NodeJs you can use the following code to create a points boost through the `admin` namespace:

Expand Down
5 changes: 2 additions & 3 deletions admin-api/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Introduction
description: Learn about the Trophy Admin API and how to use it to drive custom
workflows using Trophy data.
title: Admin API introduction
description: Use the Trophy Admin API to manage metrics, achievements, leaderboards, points, and other gamification configuration through code.
subtitle: Learn about the Trophy Admin API and how to use it to drive custom
workflows using Trophy data.
---
Expand Down
4 changes: 2 additions & 2 deletions admin-api/rate-limiting.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Rate Limiting
description: Learn about the Trophy API and request rate limiting.
title: Admin API rate limiting
description: Understand the request rate limits applied to Trophy Admin API endpoints, the response headers returned, and how to handle 429 errors.
og:description: Learn about the Trophy API and request rate limiting.
icon: circle-gauge
---
Expand Down
5 changes: 2 additions & 3 deletions api-reference/authentication.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Authentication
description: Integrate securely with the API using account-level API keys
transmitted in the `X-API-KEY` header.
title: Application API authentication
description: Authenticate Application API requests with account-level API keys sent in the X-API-KEY header to power in-app gamification features.
og:description: Integrate securely with the Trophy API using account-level API
keys transmitted in the `X-API-KEY` header.
icon: key
Expand Down
4 changes: 2 additions & 2 deletions api-reference/client-libraries.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Client Libraries
description: Use Trophy's type-safe SDKs to integrate with the API.
title: Application API client libraries
description: Install Trophy's type-safe SDKs for Node.js, Python, and other languages to integrate the Application API and build gamification features.
og:description: Use Trophy's type-safe SDKs to integrate with the API and start
building gamified product experiences.
icon: code-xml
Expand Down
5 changes: 2 additions & 3 deletions api-reference/idempotency.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Idempotency
description: Prevent unintended side effects when retrying requests with
idempotency controls built into the Trophy API and SDKs.
title: API idempotency
description: Safely retry Trophy API requests using the Idempotency-Key header to prevent duplicate event tracking and unintended side effects on retries.
og:description: Prevent unintended side effects when retrying requests with
idempotency built into the Trophy API and SDKs using the
`Idempotency-Key` request header.
Expand Down
4 changes: 2 additions & 2 deletions api-reference/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Introduction
description: Learn about the Trophy API and get started building your integration.
title: Application API introduction
description: Use the Trophy Application API to track user events, complete achievements, query streaks, and power gamification features in your app.
subtitle: Learn about the Trophy API and get started building your integration.
---

Expand Down
4 changes: 2 additions & 2 deletions api-reference/rate-limiting.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Rate Limiting
description: Learn about the Trophy API and request rate limiting.
title: Application API rate limiting
description: Understand the request rate limits applied to Trophy Application API endpoints, the response headers returned, and how to handle 429 errors.
og:description: Learn about the Trophy API and request rate limiting.
icon: circle-gauge
---
Expand Down
2 changes: 1 addition & 1 deletion features/achievements.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Achievements
description: Learn how to use Achievements in a gamified product experience with Trophy.
description: Reward users with metric, API, streak, and composite achievements that recognize progress, drive feature discovery, and boost retention.
og:description: Use metric, API, streak and composite achievements to reward
users for continued progress and to encourage them to discover new parts of
your app.
Expand Down
2 changes: 1 addition & 1 deletion features/emails.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Emails
description: Learn how to use emails in a gamified product experience with Trophy.
description: Send automated gamification emails for achievements, streaks, and points to re-engage users and drive retention without writing email code.
og:description: Use automated email flows to extend your gamification experience
outside your app and remind users to keep coming back.
icon: mail
Expand Down
3 changes: 1 addition & 2 deletions features/events.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Events
description: Events are data objects that represent individual user interactions
against metrics in Trophy.
description: Track individual user interactions in Trophy by sending metric events that drive achievements, streaks, points, and leaderboard rankings.
og:description: Events are data objects that represent individual user
interactions against metrics in Trophy.
icon: radio
Expand Down
2 changes: 1 addition & 1 deletion features/leaderboards.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Leaderboards
description: Learn how to use Leaderboards in a gamified product experience with Trophy.
description: Run daily, weekly, or monthly leaderboards that rank users by metrics, points, or streaks to drive competition and engagement in your app.
og:description: Create daily, weekly or monthly competitions that rank users
based on metrics, points or streaks and increase user engagement.
icon: /icons/leaderboard.svg
Expand Down
4 changes: 1 addition & 3 deletions features/metrics.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: Metrics
description: Learn how to model user interactions using Trophy Metrics. Model
any user interaction and trigger automated gamification flows with just a few
lines of code.
description: Model any user interaction with Trophy metrics, the flexible primitive that powers achievements, streaks, points, and leaderboards.
og:description: Metrics are flexible data primitives that can be used to model
any user interaction and drive a wide range of gamified features.
icon: box
Expand Down
4 changes: 2 additions & 2 deletions features/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Overview
description: Learn the key concepts behind Trophy's gamification system.
title: Trophy features overview
description: Learn the key concepts behind Trophy's gamification system, including metrics, events, achievements, streaks, points, and leaderboards.
og:description: Learn the key concepts behind Trophy's gamification system
including Metrics, Events, Achievements and Streaks.
---
Expand Down
2 changes: 1 addition & 1 deletion features/points.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Points
description: Learn how to build points-based systems using Trophy
description: Build points systems with triggers, levels, and boosts to reward users for in-app actions and create XP-style progression in your product.
og:description: Use points systems to reward users for in-app actions.
icon: sparkle
---
Expand Down
5 changes: 2 additions & 3 deletions features/push-notifications.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Push Notifications
description: Learn how to use push notifications in a gamified product
experience with Trophy.
title: Push notifications
description: Send automated push notifications for achievements, streaks, and points to bring users back to your mobile app and increase engagement.
og:description: Use automated push notification flows to extend your
gamification experience outside your app and remind users to keep coming back.
icon: bell
Expand Down
2 changes: 1 addition & 1 deletion features/streaks.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Streaks
description: Learn how to use streaks in a gamified product experience with Trophy.
description: Build daily, weekly, or monthly streaks with freezes and restorations to drive habit formation and keep users returning to your app.
og:description: Use daily, weekly or monthly streaks to create habitual usage
patterns and keep users coming back to your app.
icon: flame
Expand Down
2 changes: 1 addition & 1 deletion features/users.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Users
description: Learn how to track interactions across your userbase using Trophy.
description: Identify and track users in Trophy, sync attributes from your app, and unify their gamification activity across metrics, points, and streaks.
og:description: Users are the people that use your platform. Learn how to tell
Trophy about them.
icon: users
Expand Down
2 changes: 1 addition & 1 deletion getting-started/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Welcome to Trophy
description: Trophy documentation for gamification APIs, quickstart guides and tutorials.
description: Trophy is a developer toolkit for adding achievements, streaks, points, and leaderboards to web and mobile apps with a few lines of code.
---

Trophy is a developer-friendly toolkit for building gamified product experiences in any mobile or web app.
Expand Down
4 changes: 2 additions & 2 deletions getting-started/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Quick Start
description: Get up and running with Trophy in under 10 minutes
title: Trophy quick start
description: Integrate Trophy into your backend in under 10 minutes and start tracking events, completing achievements, and powering gamified features.
og:description: Follow this quick start guide to integrate Trophy into your
backend and add gamified features like achievements and streaks into your app.
---
Expand Down
6 changes: 2 additions & 4 deletions guides/gamified-fitness-platform.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: How to Build a Gamified Fitness Tracker
description: Learn how to build a Strava-like fitness app with Next.js,
featuring multi-sport tracking, city-based leaderboards, and normalized XP
progression.
title: How to build a gamified fitness tracker
description: Build a Strava-like fitness tracker with Next.js and Trophy, featuring multi-sport tracking, city-based leaderboards, streaks, and XP progression.
subtitle: Build a high-retention fitness app with streaks and leaderboards.
---

Expand Down
5 changes: 2 additions & 3 deletions guides/gamified-study-platform.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: How to Build a Gamified Study Platform
description: Follow along as we build out a gamified study platform using Trophy
with achievements, a daily streak, XP and leaderboards.
title: How to build a gamified study platform
description: Build a gamified study platform with Trophy using achievements, a daily study streak, XP-style points, and leaderboards to drive learner retention.
subtitle: Follow along as we build out a gamified study platform using Trophy.
noindex: true
---
Expand Down
5 changes: 2 additions & 3 deletions guides/how-to-build-a-leaderboards-feature.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: How To Build A Leaderboards Feature
description: Learn how to use Trophy to add a leaderboards feature to your web
or mobile app.
title: How to build a leaderboards feature
description: Add a leaderboards feature to your web or mobile app with Trophy by tracking metric events, configuring rankings, and rendering leaderboard data.
subtitle: Learn how to use Trophy to add a leaderboards feature to your web or
mobile app.
noindex: true
Expand Down
4 changes: 2 additions & 2 deletions guides/how-to-build-a-streaks-feature.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: How To Build A Streaks Feature
description: Learn how to use Trophy to add a streaks feature to your web or mobile app.
title: How to build a streaks feature
description: Add a daily or weekly streaks feature to your web or mobile app with Trophy by sending metric events and reading streak status from the API.
subtitle: Learn how to use Trophy to add a streaks feature to your web or mobile app.
noindex: true
---
Expand Down
5 changes: 2 additions & 3 deletions guides/how-to-build-an-achievements-feature.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: How To Build An Achievements Feature
description: Learn how to use Trophy to add an achievements feature to your web
or mobile app.
title: How to build an achievements feature
description: Add an achievements feature to your web or mobile app with Trophy by defining metric-based and API-triggered achievements and displaying badges.
subtitle: Learn how to use Trophy to add an achievements feature to your web or
mobile app.
noindex: true
Expand Down
4 changes: 2 additions & 2 deletions guides/how-to-build-an-energy-feature.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: How To Build An Energy Feature
description: Learn how to use Trophy to add an energy feature to your web or mobile app.
title: How to build an energy feature
description: Build a Duolingo-style energy or hearts feature with Trophy points, including spending, regeneration timers, and full-bar UI states.
subtitle: Learn how to use Trophy to add an energy feature to your web or mobile app.
noindex: true
---
Expand Down
4 changes: 2 additions & 2 deletions guides/how-to-build-an-xp-feature.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: How To Build An XP Feature
description: Learn how to use Trophy to add an XP feature to your web or mobile app.
title: How to build an XP feature
description: Add an XP and leveling feature to your web or mobile app with Trophy points systems, level thresholds, and progression-driven rewards.
subtitle: Learn how to use Trophy to add an XP feature to your web or mobile app.
noindex: true
---
Expand Down
2 changes: 1 addition & 1 deletion platform/environments.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Environments
description: Learn how to use environments to help you test and review changes before releasing to production.
description: Use Trophy environments to isolate gamification data, test configuration changes safely, and promote updates from development to production.
og:description: Learn how to use environments to help you test and review changes before releasing to production.
icon: layers
---
Expand Down
3 changes: 1 addition & 2 deletions platform/experimentation.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Experimentation
description: Learn how to use Trophy to experiment with the gamification
experience and increase retention and user engagement.
description: Run A/B tests on Trophy gamification features using control flags and audience targeting to measure the impact on retention and engagement.
og:description: Learn how to use Trophy to experiment with the gamification
experience and increase retention and user engagement.
icon: flask-conical
Expand Down
4 changes: 2 additions & 2 deletions platform/multi-tenancy.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Multi-Tenancy
description: Learn how to use multi-tenancy to help you set up and customize gamification features for each of your customers.
title: Multi-tenancy
description: Use Trophy multi-tenancy to configure and customize gamification features per customer or workspace from one shared Trophy account.
og:description: Learn how to use multi-tenancy to help you set up and customize gamification features for each of your customers.
icon: building
---
Expand Down
4 changes: 2 additions & 2 deletions platform/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Overview
description: Learn how to configure and operate the Trophy platform.
title: Platform overview
description: Configure and operate the Trophy platform with environments, multi-tenancy, and experimentation tools to ship gamification features safely.
---

From isolating data across environments to powering multi-tenant gamification and running experiments on your gamification experience, this section of the documentation covers how to configure and operate the Trophy platform.
Expand Down
1 change: 1 addition & 0 deletions uikit/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Gamification UI Kit
description: Drop in prebuilt Trophy UI components for achievements, streaks, points, and leaderboards to add polished gamification screens to your app.
---

<Frame>
Expand Down
5 changes: 2 additions & 3 deletions webhooks/idempotency.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Idempotency
description: Learn how to ensure your webhook endpoints only process events once
to prevent unintended side effects.
title: Webhook idempotency
description: Ensure your webhook endpoints process each Trophy event exactly once by deduplicating delivery attempts using the event ID header.

Check warning on line 3 in webhooks/idempotency.mdx

View check run for this annotation

Mintlify / Mintlify Validation (trophy) - vale-spellcheck

webhooks/idempotency.mdx#L3

Did you really mean 'deduplicating'?
subtitle: Learn how to ensure your webhook endpoints only process events once to
prevent unintended side effects.
icon: repeat
Expand Down
5 changes: 2 additions & 3 deletions webhooks/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Introduction
description: Learn about webhooks in Trophy and how to use them to power custom
gamification integrations.
title: Webhooks introduction
description: Subscribe to Trophy webhook events to react to achievement completions, streak changes, points updates, and other gamification activity.
subtitle: Learn about webhooks in Trophy and how to use them to power custom
gamification integrations.
---
Expand Down
2 changes: 1 addition & 1 deletion webhooks/observability.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Observability
description: Learn how to monitor and diagnose issues with webhook delivery.
description: Monitor Trophy webhook delivery, inspect event payloads, and diagnose failed deliveries using built-in dashboard analytics and event logs.
subtitle: Learn how to monitor and diagnose issues with webhook delivery.
icon: activity
---
Expand Down
4 changes: 2 additions & 2 deletions webhooks/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Quick Start
description: Start receiving webhook events from Trophy in under 10 minutes.
title: Webhooks quick start
description: Configure a Trophy webhook endpoint and start receiving real-time events for achievements, streaks, points, and leaderboards in 10 minutes.
subtitle: Start receiving webhook events from Trophy in under 10 minutes.
icon: circle-play
---
Expand Down
2 changes: 1 addition & 1 deletion webhooks/retries.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Retries
description: Learn how Trophy handles webhook retries with configured endpoints.
description: Understand how Trophy retries failed webhook deliveries with exponential backoff after timeouts, network errors, and non-2XX HTTP responses.

Check warning on line 3 in webhooks/retries.mdx

View check run for this annotation

Mintlify / Mintlify Validation (trophy) - vale-spellcheck

webhooks/retries.mdx#L3

Did you really mean 'backoff'?
subtitle: Learn how Trophy handles webhook retries with configured endpoints.
icon: rotate-ccw
---
Expand Down
2 changes: 1 addition & 1 deletion webhooks/security.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Security
description: Build secure webhook endpoints using webhook signature verification.
description: Secure your Trophy webhook endpoints by verifying the X-Trophy-Signature header so only authentic events from Trophy are processed.
subtitle: Build secure webhook endpoints using webhook signature verification.
icon: shield-check
---
Expand Down
Loading