Skip to content
Closed
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 how Trophy's monthly active user pricing works, how usage is measured, and how to control billing costs as your product grows.
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: Customize the logo, brand colors, and visual identity Trophy applies to leaderboards, emails, and other user-facing gamification surfaces.
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, assign roles, and manage member permissions to collaborate on gamification configuration.
og:description: Give team members access to Trophy and manage your account settings.
icon: user-plus
---
Expand Down
2 changes: 1 addition & 1 deletion 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.
description: Manage your Trophy account including billing, team members, branding, and other workspace-wide settings that apply across your environments.
---

From inviting team members to understanding billing, this section of the documentation is dedicated to managing your Trophy account.
Expand Down
3 changes: 1 addition & 2 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.
description: Authenticate Trophy Admin API requests with account-level API keys passed in the X-API-KEY header to manage metrics, points, and leaderboards.
og:description: Integrate securely with the Trophy API using account-level API
keys transmitted in the `X-API-KEY` header.
icon: key
Expand Down
2 changes: 1 addition & 1 deletion 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.
description: Use Trophy's type-safe Admin API SDKs for Node.js, Python, and other languages to programmatically manage metrics, points, and leaderboards.
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
3 changes: 1 addition & 2 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.
description: Get started with the Trophy Admin API to programmatically configure metrics, points systems, leaderboards, and other gamification resources.
subtitle: Learn about the Trophy Admin API and how to use it to drive custom
workflows using Trophy data.
---
Expand Down
2 changes: 1 addition & 1 deletion 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.
description: Understand Trophy Admin API rate limits, response headers, and best practices for retrying requests when configuring resources at scale.
og:description: Learn about the Trophy API and request rate limiting.
icon: circle-gauge
---
Expand Down
3 changes: 1 addition & 2 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.
description: Authenticate Trophy API requests with account-level API keys passed in the X-API-KEY header to securely track events and update users.
og:description: Integrate securely with the Trophy API using account-level API
keys transmitted in the `X-API-KEY` header.
icon: key
Expand Down
2 changes: 1 addition & 1 deletion 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.
description: Use Trophy's type-safe SDKs for Node.js, Python, Go, and other languages to track events, identify users, and build gamified product 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
3 changes: 1 addition & 2 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.
description: Use the Idempotency-Key header in the Trophy API to safely retry requests without creating duplicate events or causing unintended side effects.
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
2 changes: 1 addition & 1 deletion 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.
description: Get started with the Trophy API to track user events, identify users, fetch leaderboard rankings, and read achievement progress in your app.
subtitle: Learn about the Trophy API and get started building your integration.
---

Expand Down
2 changes: 1 addition & 1 deletion 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.
description: Understand Trophy API rate limits, response headers, and best practices for retrying requests when tracking high-volume user events.
og:description: Learn about the Trophy API and request rate limiting.
icon: circle-gauge
---
Expand Down
2 changes: 1 addition & 1 deletion experimentation/engagement.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Engagement
description: Learn how to measure the impact of gamification on engagement
description: Measure how Trophy's gamification features influence user engagement by comparing session frequency and event volume across cohorts.
og:description: Learn how to measure the impact of gamification on engagement
icon: heart
---
Expand Down
3 changes: 1 addition & 2 deletions experimentation/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Overview
description: Learn how to use Trophy to experiment with the gamification
experience and increase retention and user engagement.
description: Use Trophy to run experiments on gamification features like streaks, points, and achievements to find what drives retention and engagement.
og:description: Learn how to use Trophy to experiment with the gamification
experience and increase retention and user engagement.
---
Expand Down
2 changes: 1 addition & 1 deletion experimentation/retention.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Retention
description: Learn how to measure the impact of gamification on retention
description: Measure how Trophy's gamification features influence retention by tracking returning users and day 7 and day 30 retention across cohorts.
og:description: Learn how to measure the impact of gamification on retention
icon: refresh-cw
---
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: Start integrating Trophy's gamification platform with quickstart guides, SDK references, and tutorials for streaks, points, and achievements.
---

Trophy is a developer-friendly toolkit for building gamified product experiences in any mobile or web app.
Expand Down
2 changes: 1 addition & 1 deletion 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
description: Integrate Trophy in under 10 minutes by installing an SDK, identifying users, and sending your first metric event to power gamification.
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 in Next.js using Trophy for multi-sport tracking, city-based leaderboards, streaks, and normalized XP.
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 Duolingo-style gamified study app with Trophy using achievements, daily streaks, XP progression, and weekly competitive leaderboards.
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 competitive leaderboards to your web or mobile app with Trophy, including ranking by metrics, points, or streaks across daily and weekly runs.
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, weekly, or monthly streaks feature to your web or mobile app with Trophy to build habits and increase user retention.
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 and badges feature to your web or mobile app with Trophy to reward user milestones and encourage product discovery.
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: Add a regenerating energy or lives system to your web or mobile app with Trophy to pace user activity and create return-to-app moments.
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 levels progression system to your web or mobile app with Trophy by rewarding user actions with points and unlocking new levels.
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/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 in Trophy to drive product discovery and recognize milestone progress.
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 platform/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 transactional emails from Trophy for streak reminders, achievement notifications, and re-engagement to bring users back.
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 platform/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: Send events to Trophy to record individual user interactions against metrics and trigger achievements, streaks, points, and leaderboard updates.
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 platform/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: Create daily, weekly, or monthly leaderboards in Trophy that rank users by metrics, points, or streak length to drive competition and engagement.
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 platform/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 in Trophy with metrics, the flexible data 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
2 changes: 1 addition & 1 deletion platform/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.
description: Learn the core Trophy concepts including users, metrics, events, achievements, streaks, points, and leaderboards that power gamified products.
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 platform/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 XP and points-based systems with Trophy using triggers, levels, and boosts to reward in-app actions and progress users through tiers.
og:description: Use points systems to reward users for in-app actions.
icon: sparkle
---
Expand Down
3 changes: 1 addition & 2 deletions platform/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.
description: Send automated push notifications from Trophy for streak reminders, achievement unlocks, and re-engagement to bring users back to your mobile app.
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 platform/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 in Trophy with configurable freezes and reminders to create habitual usage patterns and retain users.
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 platform/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 users in Trophy with stable IDs, attributes, and notification preferences to track gamification progress across your product.
og:description: Users are the people that use your platform. Learn how to tell
Trophy about them.
icon: users
Expand Down
3 changes: 1 addition & 2 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.
description: Use Trophy webhook event IDs to deduplicate deliveries and ensure your endpoints process each event exactly once, even when retries occur.

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 'deduplicate'?
subtitle: Learn how to ensure your webhook endpoints only process events once to
prevent unintended side effects.
icon: repeat
Expand Down
3 changes: 1 addition & 2 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.
description: Use Trophy webhooks to receive real-time events for achievements, streaks, points, and leaderboards and power custom gamification integrations.
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 in the dashboard with delivery logs, response codes, and tools to replay failed events and diagnose endpoint issues.
subtitle: Learn how to monitor and diagnose issues with webhook delivery.
icon: activity
---
Expand Down
2 changes: 1 addition & 1 deletion 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.
description: Configure a Trophy webhook endpoint in under 10 minutes to start receiving real-time achievement, streak, points, and leaderboard events.
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 and how to design endpoints that handle retries correctly.

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 request signatures with your signing secret to confirm payloads originated from Trophy.
subtitle: Build secure webhook endpoints using webhook signature verification.
icon: shield-check
---
Expand Down
Loading