April 2022 Release

Production Release Date: April 27th

REST APIs

The following API changes are documented on https://api.bunchball.com/docs.

• GET, POST, and DELETE /challenges/{challengeId}/action-rules - added the displayOrder parameter to ruleSubtasks.

• POST and GET /challenges/{challengeId}/goals - deprecated. Use /challenges/action-rules/{ruleId}/goals as the replacement.

• GET, PUT, and DELETE /challenges/{challengeId}/goals/{goalId} - deprecated. Use /challenges/action-rules/goals/{goalId} as the replacement.

• POST /challenges and PUT /challenges/{challengeId} - supports the "hidden" attribute. The "hideUntilEarned" attribute is deprecated but still supported.

• /challenges, /users/{userId}/challenges, /users/{userId}/challenges/{challengeId}/progress, /groups/{groupId}/challenges, and /groups/{groupId}/challenges/{challengeId}/progress - added the following attributes: featured, eligibilityStatus, allowsPartialProgress, percentComplete, completionCount, and lastCompletedTime.

Product Enhancements

New Mission Builder

Our new mission builder is now available! The mission builder will be enabled for some programs in April and all remaining programs with our May release. If you're interested in using our new builder today, please contact Bunchball Support to request that we enable this feature for your program.

This builder has feature parity with our legacy challenge builder, but it also:

• Has a new rule builder where you can configure rules with different AND/OR combinations. Show me an example

You can now have multiple actions with an "or" relationship within the same rule. When multiple rules are within the same challenge, they can have an "and" or an "or" relationship. If you add multiple actions to the same rule, they assume an "or" relationship and any combination of the selected actions will contribute toward completion. For example, a rule can complete when a user watches 5 videos, reads 5 articles, or watches 2 videos and reads 3 articles.

• Has a header section where you can quickly view important details and make the challenge active or inactive.

• Has a section for adding labels, featured status, and importance (previously available in the list view).

• Allows you to save as you edit individual fields or tabs and doesn’t require you to wait until the entire challenge is configured.

• Is redesigned for greater flexibility and usability.

New Self-Reporting Rules

We're excited to announce that we now have a new way to log user activity! Self-reporting rules allow a user to mark a task as complete in the Missions web component. The action tied to the self-reporting rule will log in Nitro with system defined metadata and any additional metadata you specify in the rule.

Self-reporting rules can be used with any action currently in your program. See Create a challenge to set up a challenge that uses a self-reporting rule.

New Missions Web Component Completed Tab

The Missions web component has a new tab for completed challenges! With this update you can:

• Show the To Do, Completed, or both tabs in the web component.

• Filter completed challenges by label.

• See when the challenge was completed and the number of completions for repeatable challenges.

• See a fun animation when opening the challenge's detail view.

• Use any links in the task list to revisit content.

This tab will show by default, but can be hidden by changing the "Show Completed Missions" option. Show me how to disable this tab

• For Bunchball Go programs, please contact Bunchball Support for assistance.

• For programs using an embedded web component, set the data-show-completed-missions parameter to 'false' in the embed code.

Challenge Management List View

The Challenge Management view has been updated to allow you to copy a challenge directly from the list view. The copy button replaces the edit button in the list. You can edit a challenge by clicking (or right-clicking) its name in the list to open it in the new mission builder.

*** Discontinuation Notice ***

As announced in previous releases, Bunchball will deprecate and remove the Performance web component from the platform. This web component will not be available in Nitro Studio after July 2022.

The GET /users/{userId}/challenges/{challengeId}/actions and /users/{userId}/challenges/{challengeId}/metrics APIs used by the Performance web component have also been deprecated.

See also

Release Notes