User-created challenges let people set their own goals. Unlike milestones set by brands, this puts users in control. They create challenges for themselves and earn rewards for completing them.
For example, a fitness brand has an app that lets users create personal challenges. For instance, a user might set a goal to drink eight glasses of water every day. They log their water intake in the app. When they reach their goal consistently for a week, they earn points. These points can be used for discounts on fitness gear or healthy snacks. This way, users feel accomplished and get rewarded for taking care of their health.
Notes
Raise a JIRA ticket to enable user-created challenges for your organisation.
Attention
- Once a user-created target group is created, it cannot be changed to a default target.
- Currently, a maximum of one Target Rule (expression) can be configured for a user-created target group.
- The Target Rules created must be of the
enrolmentMethodIMPORTfor a user-created target group.
The following table list the APIs that can be used to create and get details of user-created challenges:
| Objective | API | Notes |
|---|---|---|
| Create behavioral event | Create event | Create and publish a new behavioural event or use an existing event. |
| Create a user-created target | Create target groups | Create the target for the behavioural event. Set the default values for the target as 2 for targetType=COUNT. |
| Create a promotion | Create promotion for UCC | While creating the promotion, set the value of id to -1 under the promotion, rulesetInfos and rules. This indicates that a new promotion request is being made in the backend. |
| Enroll a user on a user-created target | Enroll a user to a milestone or streak | Enrolling a user on a user-created target can be done using the enrol API. Set the targetGroupId and targetID of the user-created target. |
| Unenroll a user from a user-created target | Unenroll a user from a milestone or streak | Enrolling a user on a user-created target can be done using the enrol API. Set the targetGroupId and targetID of the user-created target. |
| Get all milestones in an organisation | Get all milestones | Set the includeUserCreatedTargetGroups parameter in the request body as true to get data related to UCC. |
| Get promotion data | Get Promotion Data | Set the sourceType as USER_CREATEDto filter filter promotions created for UCC. |
| Get all user-created target groups | Get target groups based on ID | Set the includeUserCreatedTargetGroups parameter in the request body as true to get data related to UCC. |
| Get user created target groups by tracking type | Get all milestones | Set the includeUserCreatedTargetGroups parameter in the request body as true to get data related to UCC. |
| Get all active targets of a customer | Get active targets | Set the includeUserCreatedTargetGroups parameter in the request body as true to get data related to UCC. |