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 usage-based pricing model based on monthly active users, plan tiers, free quotas, and how to manage your subscription.
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 organization's logo, brand colors, and visual identity used across Trophy emails, push notifications, and gamified experiences.
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 organization, manage member roles and permissions, and control access to your gamification dashboard.
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 organization including team members, billing details, branding, and other account-level settings from the Trophy dashboard.
---

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 securely using account-level API keys transmitted in the X-API-KEY header from your server.
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 SDKs in Node.js, Python, Go, Ruby, and more to call Admin API endpoints through the trophy.admin client namespace.

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

View check run for this annotation

Mintlify / Mintlify Validation (trophy) - vale-spellcheck

admin-api/client-libraries.mdx#L3

Did you really mean 'namespace'?
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: Drive custom gamification workflows using the Trophy Admin API to manage metrics, achievements, leaderboards, and points programmatically.
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: Learn the Trophy Admin API rate limits, tiered request quotas, and how to handle 429 responses when integrating administrative workflows.
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 Application API requests securely from your backend using account-level API keys sent in the X-API-KEY header.
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: Integrate the Trophy Application API using official SDKs available in Node.js, Python, Go, Ruby, Java, and PHP for type-safe gamification.
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 and built-in SDK controls to safely retry Trophy API requests without double-counting events or awards.
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 Application API to build achievements, streaks, points, and leaderboards into your web or mobile application.
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: Learn the Trophy Application API rate limit tiers, per-endpoint quotas, and how to handle 429 responses gracefully in your integration.
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 to encourage progress and drive discovery across your product experience.
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, branded gamification emails like progress updates and reactivation messages to keep users engaged outside your app.
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: Send events to Trophy to represent 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 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: Create daily, weekly, or monthly recurring leaderboards that rank users by metrics, points, or streaks 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 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 to power achievements, streaks, points, and leaderboards from a single source of truth.
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 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.
description: Understand the core Trophy concepts including metrics, events, users, achievements, streaks, points, and leaderboards that power gamification.
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 XP and points systems with triggers, levels, and boosts to reward users for in-app actions and create long-term progression loops.
og:description: Use points systems to reward users for in-app actions.
icon: sparkle
---
Expand Down
3 changes: 1 addition & 2 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.
description: Send automated, branded push notifications for achievements, streaks, and progress updates to bring users back into 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 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 streak freezes and rankings to create habits and keep users returning to your app daily.
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 to attribute events, achievements, streaks, and points across your entire product userbase over time.
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, leaderboards, and gamified emails to any web or mobile app.
---

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 into your backend in under 10 minutes to start tracking events, awarding achievements, and powering gamified user experiences.
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
4 changes: 1 addition & 3 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.
description: Build a Strava-style fitness app with Next.js and Trophy, featuring multi-sport tracking, city leaderboards, streaks, and XP progression.
subtitle: Build a high-retention fitness app with streaks and leaderboards.
---

Expand Down
3 changes: 1 addition & 2 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.
description: Build a gamified study platform with Trophy using achievements, daily streaks, XP, levels, and leaderboards to drive learner engagement.
subtitle: Follow along as we build out a gamified study platform using Trophy.
noindex: true
---
Expand Down
3 changes: 1 addition & 2 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.
description: Add ranked leaderboards to your web or mobile app with Trophy, including setup, recurring runs, tie-breakers, and displaying user rankings.
subtitle: Learn how to use Trophy to add a leaderboards feature to your web or
mobile app.
noindex: true
Expand Down
2 changes: 1 addition & 1 deletion 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.
description: Add a daily, weekly, or monthly streak feature to your web or mobile app using Trophy with streak freezes and progress UI components.
subtitle: Learn how to use Trophy to add a streaks feature to your web or mobile app.
noindex: true
---
Expand Down
3 changes: 1 addition & 2 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.
description: Add metric, API, and composite achievements to your web or mobile app using Trophy, including unlocking, displaying, and rewarding users.
subtitle: Learn how to use Trophy to add an achievements feature to your web or
mobile app.
noindex: true
Expand Down
2 changes: 1 addition & 1 deletion 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.
description: Build an energy or stamina system in your web or mobile app using Trophy points to limit user actions and create rest-and-recover loops.
subtitle: Learn how to use Trophy to add an energy feature to your web or mobile app.
noindex: true
---
Expand Down
2 changes: 1 addition & 1 deletion 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.
description: Add an XP and levels system to your web or mobile app with Trophy points, level triggers, progress bars, and reward unlocks for users.
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: Isolate development, staging, and production data with Trophy environments and safely promote gamification changes before going live.
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 your Trophy gamification experience with control flags to measure retention and engagement lifts before rolling out.
og:description: Learn how to use Trophy to experiment with the gamification
experience and increase retention and user engagement.
icon: flask-conical
Expand Down
2 changes: 1 addition & 1 deletion 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.
description: Use Trophy multi-tenancy to provision and customize separate gamification configurations for each of your B2B customers from one 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
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 how to configure and operate the Trophy platform.
description: Configure and operate the Trophy platform using environments, multi-tenancy, and experimentation to manage gamification across customers at scale.
---

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: Trophy's Gamification UI Kit is a React component library built on shadcn/ui for streaks, achievements, leaderboards, points, and levels.
---

<Frame>
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: Make your Trophy webhook handlers idempotent using event IDs so you safely process each event exactly once even when retries occur.
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: Receive Trophy webhook events for achievements, streaks, points, and leaderboards to power custom integrations and real-time workflows.
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 and diagnose Trophy webhook delivery using built-in dashboard analytics, status tracking, payload inspection, and delivery logs.
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 and start receiving real-time gamification events directly in your backend service.
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 after timeouts or non-2xx responses, with backoff schedules and dead-letter handling.

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 signed payloads with HMAC signatures to ensure events come from Trophy and not attackers.
subtitle: Build secure webhook endpoints using webhook signature verification.
icon: shield-check
---
Expand Down
Loading