Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Challenge details page

To provide customers with information about a specific challenge, you can create a Challenge Details page within your mobile app.

Accessing Challenge Details

To retrieve the necessary information for a specific challenge, utilize the following endpoints:

  1. Challenge Perk Requirement Endpoint: This endpoint provides detailed specific actions or activities that must be completed in the challenge.

  2. Challenge Connection Requirement Summary Endpoint: Challenge Connection Requirement Summary shows a user’s progress on each individual activity for a challenge, and whether they’ve completed this activity.

Displaying requirement rewards

The Challenge Perk Requirement response includes:

Field
Meaning

completion_points

Points configured for completing the requirement; 0 when no points are configured.

completion_instant_rewards

A list of active instant reward perk URIs configured for completing the requirement; empty when none are configured.

Both fields can be populated. Display these rewards with their individual requirement, separately from the final challenge completion reward. Resolve the instant reward perk URIs to obtain the reward details your interface needs.

These are read-only configuration fields. Configure milestone rewards in the business's challenge settings.

Distinguishing progress from reward receipt

Use the Challenge Connection Requirement Summary for the customer's progress, and the Challenge Connection for their enrollment state. A completed requirement alone does not establish that the customer received its reward.

  • Customers must be enrolled and complete the requirement to earn a milestone reward.

  • For a completed requirement when the customer has not joined, show a join prompt rather than a reward-received indicator.

  • completion_points and completion_instant_rewards describe the configured reward. They are not payout status or voucher-delivery confirmation.

  • A challenge completion date is the date of completion, not proof of reward delivery.

Continue recording qualifying activity against the requirement's progress_perk. Do not create a separate reward transaction from the client: Perkville handles milestone issuance.

See Challenge Rewards for the distinction between milestone, final completion, and participation rewards.

Example challenge screen

Illustrative Fall fitness challenge showing a completed five-class milestone with 25 points and a free smoothie, check-in progress at five of ten, an incomplete personal training requirement, and a locked final reward of 100 points and a free week of training.
Illustrative example using the current challenge UI. Requirement rewards appear beside their goals; the trophy section shows the separate final completion reward.

Last updated

Was this helpful?