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/members.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ og:description: Give team members access to Trophy and manage your account setti
icon: user-plus
---

## Invite Your team {#invite-your-team}
## Invite Your Team {#invite-your-team}

Trophy supports up to 5 team members per organization. However if you feel you need more [just ask](mailto:support@trophy.so) and we'll be happy to give you more room.

Expand Down
10 changes: 5 additions & 5 deletions api-reference/authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Trophy keeps track of and displays when each API key in your account was created
<img height="200" noZoom src="../assets/api/authentication/api_keys.png" />
</Frame>

### Anatomy of an API key {#anatomy-of-an-api-key}
### Anatomy of an API Key {#anatomy-of-an-api-key}

Each API key is made up of 2 parts separated by a period:

Expand All @@ -44,7 +44,7 @@ curl https://app.trophy.so/api/users/<userId>/metrics/<key> \

If you do not pass an API key, or your API key is invalid, you'll receive a `401` response code.

## Managing API keys {#managing-api-keys}
## Managing API Keys {#managing-api-keys}

There are a few different operations you can perform on API keys from within your Trophy dashboard to manage your integration.

Expand All @@ -56,15 +56,15 @@ There are a few different operations you can perform on API keys from within you
/>
</Frame>

### Rotating keys {#rotating-keys}
### Rotating Keys {#rotating-keys}

API keys can be rotated if you want to change them for any reason. At the point of rotation, the original API key will no longer function and any requests still using it will begin receiving `401` responses immediately.

<Note>
Note that when rotating keys, both the prefix and the body will change.
</Note>

### Revoking keys {#revoking-keys}
### Revoking Keys {#revoking-keys}

API keys can also be revoked entirely at which point they become _Inactive_. At the point of revocation, the API key will no longer function and any requests still using it will begin receiving `401` responses immediately.

Expand All @@ -74,7 +74,7 @@ Once revoked you can re-activate the API key at any time.
Neither the prefix or the body of the key change when revoked or re-activated.
</Note>

### Deleting API keys {#deleting-api-keys}
### Deleting API Keys {#deleting-api-keys}

If you're 100% sure you no longer need an API key, they can be deleted.

Expand Down
6 changes: 3 additions & 3 deletions features/achievements.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ icon: trophy
import MetricChangeResponseBlock from "../snippets/metric-change-response-block.mdx";
import AllAchievementsResponseBlock from "../snippets/all-achievements-response-block.mdx";

## What Are Achievements? {#what-are-achievements}
## What are Achievements? {#what-are-achievements}

Achievements are rewards that users can unlock as they use your platform. They can be used to reward users for making continued progress along core user journeys, or to motivate users to explore more nascent features.

Expand All @@ -23,9 +23,9 @@ are likely to lead to increased retention.
these interactions to maximize retention impact.
</Tip>

Here we'll have a look of the types of achievements you can build with Trophy, the different ways to use them, and how to integrate them into your platform.
Here we'll have a look at the types of achievements you can build with Trophy, the different ways to use them, and how to integrate them into your platform.

Watch Charlie run walk through using achievements in a NextJS application:
Watch Charlie walk through using achievements in a NextJS application:

<Frame>
<iframe
Expand Down
6 changes: 3 additions & 3 deletions features/emails.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { PlanBadge } from "../components/plan-badge.jsx";

Trophy can send automated emails to users based on key triggers without requiring any code. Here we'll look at what these triggers are, and how they can form part of your product's gamification experience.

## Types Of Emails {#types-of-emails}
## Types of Emails {#types-of-emails}

Trophy supports 4 types of emails, each of which is designed to suit a common scenario in building gamification experiences.

Expand Down Expand Up @@ -325,7 +325,7 @@ By default, Trophy provides a template for each [email type](#types-of-emails) a
You can also create blank templates if you just want to start from scratch.
</Tip>

### Creating A New Template {#creating-a-new-template}
### Creating a New Template {#creating-a-new-template}

To create a new email template, follow the steps below.

Expand Down Expand Up @@ -707,7 +707,7 @@ To create a variation click the _Add Variation_ button on any block that support
tuned...
</Note>

### Using The Editor {#using-the-editor}
### Using the Editor {#using-the-editor}

The email template editor is a blank canvas for designing emails that look great in the inbox. Using pre-configured [Blocks](#block-types) makes it really easy to create email templates that suit common gamification use cases. Here we'll walk through how to best use the editor to create awesome looking emails.

Expand Down
6 changes: 3 additions & 3 deletions features/points.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ This allows you to control the rate at which users can use your product with a f

## Creating Points Systems {#creating-points-systems}

Trophy let's you set up multiple points systems for different use cases within your application.
Trophy lets you set up multiple points systems for different use cases within your application.

<Frame>
<video
Expand Down Expand Up @@ -301,7 +301,7 @@ Each level has a threshold. When a user's total points in the system exceeds thi

Use levels for rank tiers, progression UI, reward tiers, or analytics. Trophy keeps each user's current level in sync whenever they earn or lose points in that system.

### Configuring levels {#configuring-levels}
### Configuring Levels {#configuring-levels}

To set up levels for a points system, open it from the [points page](https://app.trophy.so/points) in the Trophy dashboard and use the levels tab to add or manage levels.

Expand Down Expand Up @@ -378,7 +378,7 @@ For server-driven notifications (email, push, CRM) that must not depend on the c

This webhook fires when a user’s level changes as a result of earning or losing points, and includes `previousLevel` and `newLevel`.

#### Account-level analytics {#account-level-analytics}
#### Account-Level Analytics {#account-level-analytics}

The [get level summary API](/api-reference/endpoints/points/get-points-level-summary) returns how many users are currently at each level which is useful for admin dashboards, funnel views, or balancing progression.

Expand Down
2 changes: 1 addition & 1 deletion features/push-notifications.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import MetricEventWithDeviceTokensRequestBlock from "../snippets/metric-event-wi

Trophy can send automated push notifications to users based on key triggers without requiring any code. Here we’ll look at what these triggers are, and how they can form part of your product’s gamification experience.

## Types Of Push Notifications {#types-of-push-notifications}
## Types of Push Notifications {#types-of-push-notifications}

Trophy supports 4 types of push notifications, each of which is designed to suit a common scenario in building gamification experiences.

Expand Down
2 changes: 1 addition & 1 deletion features/streaks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ For a full walk through on how to set up a streak feature using Trophy, check ou

This section outlines some of the operations you can perform to manage user's streaks in your application.

### Restoring A Users Streak {#restoring-a-users-streak}
### Restoring a User's Streak {#restoring-a-users-streak}

To restore a user's streak, head to the user details page and use the 'Restore Streak' action. Restoring a user's streak sets it to the length it was when they last lost it.

Expand Down
2 changes: 1 addition & 1 deletion getting-started/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Here you'll integrate your backend web application with Trophy and start buildin

</Step>
<Step title="Integrate the metric into your backend">
Once you've created your metric, head to the configure tab and copy it's unique API reference key.
Once you've created your metric, head to the configure tab and copy its unique API reference key.

<Frame>
<video
Expand Down
4 changes: 2 additions & 2 deletions platform/experimentation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Analytics dashboards then compare retention and user engagement between users in

Both retention and user engagement are important metrics to use when measuring the impact of changes on the user experience. The following sections outline what each means and how it relates to features you build with Trophy.

## What Is Retention? {#what-is-retention}
## What is Retention? {#what-is-retention}

User retention is the percentage of users who are still using your product after a certain period.

Expand Down Expand Up @@ -85,7 +85,7 @@ The [integration page](https://app.trophy.so/integration/configure) allows you t
/>
</Frame>

## What Is Engagement? {#what-is-engagement}
## What is Engagement? {#what-is-engagement}

User engagement in Trophy refers to the average level of activity that your users show when using your product.

Expand Down
2 changes: 1 addition & 1 deletion platform/multi-tenancy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Similarly, customers who use multi-tenancy then make use of the [Application API

In this way, you can power complex gamification features for your own customers, without building or maintaining any gamification infrastructure yourself, and critically whilst upholding your own brand.

## What Is A Tenant? {#what-is-a-tenant}
## What is a Tenant? {#what-is-a-tenant}

A tenant is a logical grouping of users and data that represent the gamification features that a single customer uses within a multi-tenant Trophy account.

Expand Down
Loading