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 billing model, monthly active user pricing, free tier limits, and how the Starter and Pro plans compare."
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 account logo, fonts, brand color, app name, and app URL so Trophy emails and notifications match your product's visual identity."
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 team members to your Trophy organization, manage admin and member roles, and control access to account settings from the 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, branding for emails and notifications, and usage-based billing for monthly active users."
---

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 Admin API requests with account-level API keys passed in the X-API-KEY header, using the same credentials as the Application API."
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: "Call the Trophy Admin API from Node.js, Python, Go, and other languages using the official type-safe SDKs under the trophy.admin 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: "Build custom gamification workflows with the Trophy Admin API, a set of endpoints for managing metrics, points, leaderboards, attributes, and tenants."
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 the request rate limits applied to every Trophy Admin API endpoint, the tier model used, and how to handle 429 Too Many Requests responses."
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 with account-level API keys sent in the X-API-KEY header, and learn how to manage keys for each environment."
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 from Node.js, Python, Go, Ruby, and other languages using the official type-safe SDKs and client libraries."
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 to safely retry Trophy Application API requests, prevent duplicate side effects, and learn which endpoints support it."
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: "Start building gamification features with the Trophy Application API, the set of endpoints your app uses to track events and read user-facing data."
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 the tiered rate limits on each Trophy Application API endpoint, the organisation-level quotas, and how to handle 429 Too Many Requests 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 one-time and metric-based achievements in Trophy, including how to configure unlock criteria, completion logic, and backdating."
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 transactional and lifecycle emails for streaks, achievements, points, and leaderboards using Trophy's built-in templates and branding controls."
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 metric events to Trophy to represent user interactions, drive achievements, streaks, points, and leaderboards, and power gamified product flows."
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: "Configure ranked, time-bound leaderboards in Trophy to drive competition between users, with support for custom scoring, tenants, and user attributes."
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
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 behind gamification, including metrics, events, achievements, streaks, points, and leaderboards, and how they connect."
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: "Design points systems in Trophy with custom triggers, levels, and boosts to power XP-style progression, currencies, and reward loops in your product."
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 mobile push notifications for streaks, achievements, points, and leaderboards in Trophy, including device token management and delivery options."
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, and custom streaks in Trophy to drive habit formation, with support for freezes, restores, and timezone-aware streak tracking."
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 users in Trophy, attach custom attributes, and track interactions across your userbase to personalize gamification and segmentation in your app."
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: "Explore Trophy's documentation for gamification APIs, including quickstart guides, feature overviews, SDK references, and end-to-end tutorials."
---

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 by creating an account, adding the SDK, identifying users, and tracking your first metric event."
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
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 that combines achievements, daily streaks, XP progression, and leaderboards to keep learners engaged."
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 a competitive leaderboards feature to your web or mobile app with Trophy, including ranking logic, time windows, tenants, and UI integration."
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 streaks feature to your web or mobile app with Trophy, including streak tracking, freezes, restores, and timezone-aware completion logic."
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 an achievements feature to your web or mobile app with Trophy, including metric-based unlocks, one-time achievements, and completion notifications."
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: "Add an energy or stamina feature to your web or mobile app with Trophy, modeling consumable resources that regenerate over time using points systems."
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 leveling feature to your web or mobile app with Trophy, including points triggers, leveling curves, level summaries, and progress UI."
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 safely test and review gamification changes in staging before promoting them to production for your live users."
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 experiments on Trophy's gamification features with control flags and audience targeting to measure their 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
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's multi-tenancy to configure and customize gamification features per customer, with isolated data, settings, and leaderboards per tenant."
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 with environments, multi-tenancy, experimentation, and other tools for managing gamification 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: "Ship gamification UI faster with Trophy's shadcn/ui-based component library for streaks, achievements, points, leaderboards, and more in React apps."
---

<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 to safely process duplicate deliveries and avoid unintended side effects on retries."
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 react to gamification events like streak changes, achievement completions, and points updates from your own backend services."
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 attempts and response codes, and diagnose failed deliveries from the dashboard to keep integrations healthy."
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: "Start receiving Trophy webhook events in under 10 minutes by registering an endpoint, verifying signatures, and handling your first achievement event."
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, when retries stop, and how to recover after extended endpoint outages."

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 ensure each event came from Trophy and is untampered."

Check warning on line 3 in webhooks/security.mdx

View check run for this annotation

Mintlify / Mintlify Validation (trophy) - vale-spellcheck

webhooks/security.mdx#L3

Did you really mean 'untampered'?
subtitle: Build secure webhook endpoints using webhook signature verification.
icon: shield-check
---
Expand Down
Loading