Achievements
Action Participations
Actions
Auth Config
Challenge Groups
Challenges
Communities
Feature Flags
Game
Leaderboards
- GETGet aggregated leaderboard data
- GETGet paginated leaderboard configurations
- Get leaderboards configs leaderboardConfigId
- GETGet distribution details for a leaderboard config
- PATCHUpdate a leaderboard configuration
- POSTCreate a new leaderboard configuration
- POSTCreate default leaderboard configs
- POSTAssign distribution details to a leaderboard config
Legal Policies
Rewards
- GETGet paginated rewards
- GETGet reward by ID
- GETGet paginated reward entries for a specific reward
- GETGet paginated reward redemption values for a specific reward
- POSTCreate a reward
- POSTUpdate a reward by id
- POSTProcess manual reward distribution
- POSTProcess manual reward giveaway
- POSTProcess reward redemption values from CSV
Tags
Teams
Templates
Third Party Config
Users
Variables
Update a streak config by id
Copy
Ask AI
curl --request PATCH \
--url https://{subdomain}.nudj.cx/api/v2/admin/streaks/configs/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-token: <api-key>' \
--data '
{
"isEnabled": true,
"triggerEvents": {
"platform": [
"achievement-completion"
],
"custom": [
"<string>"
]
}
}
'Copy
Ask AI
{
"id": "<string>",
"organisationId": "<string>",
"isEnabled": true,
"triggerEvents": {
"platform": [
"achievement-completion"
],
"custom": [
"<string>"
]
},
"createdBy": "<string>",
"updatedBy": "<string>",
"communityId": "<string>"
}Streaks
Update a streak config by id
Update a streak config by id.
PATCH
/
streaks
/
configs
/
{id}
Update a streak config by id
Copy
Ask AI
curl --request PATCH \
--url https://{subdomain}.nudj.cx/api/v2/admin/streaks/configs/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-token: <api-key>' \
--data '
{
"isEnabled": true,
"triggerEvents": {
"platform": [
"achievement-completion"
],
"custom": [
"<string>"
]
}
}
'Copy
Ask AI
{
"id": "<string>",
"organisationId": "<string>",
"isEnabled": true,
"triggerEvents": {
"platform": [
"achievement-completion"
],
"custom": [
"<string>"
]
},
"createdBy": "<string>",
"updatedBy": "<string>",
"communityId": "<string>"
}Authorizations
Path Parameters
The id of the streak config to update
Body
application/json
The input required to update a streak config
Whether the streak is enabled and users can start and extend streaks.
Show child attributes
Show child attributes
The Nudj platform events that trigger the streak to be extended for a user. For example, challenge completions.
Available options:
achievement-completion, facebook-comment, facebook-follow, facebook-like, image-analysis-object-detection, image-analysis-receipt-detection, instagram-follow, instagram-like, instagram-comment, instagram-share, instagram-post, interaction-engage-with-content, interaction-external-link, interaction-image-upload, interaction-spot-object, platform-comment-on-post, platform-complete-achievement, platform-generative-action, platform-like-post, platform-play-game, platform-validate-event, question-multiple-choice, question-open-ended, question-rate-your-experience, question-secret-access-code, question-select-date, question-select-from-images, question-select-value-in-range, question-select-from-list, question-closed-ended, question-vote, spotify-follow, spotify-listen, spotify-save, tiktok-follow, tiktok-watch, tiktok-post, youtube-like, youtube-comment, youtube-subscribe, action-completion, skip-action, 42-school, api-auth-link, api-token-link, apple, asgardeo, atlassian, auth0, authentik, azure-ad-b2c, azure-ad, azure-devops, battlenet, beyondidentity, box, boxyhq-saml, bungie, click-up, cognito, coinbase, descope, discord, dribbble, dropbox, duende-identity-server6, email, eveonline, facebook, faceit, foursquare, freshbooks, fusionauth, github, gitlab, google, hubspot, identity-server4, instagram, kakao, keycloak, line, linkedin, mailchimp, mailru, mastodon, mattermost, medium, naver, netlify, notion, okta, onelogin, organisation-oidc, osso, osu, passage, patreon, pinterest, pipedrive, reddit, salesforce, slack, spotify, strava, tiktok, todoist, trakt, twitch, twitter, united-effects, vk, wikimedia, wordpress, workos, yandex, youtube, zitadel, zoho, zoom, blog-comment, blog-like, blog-share, blog-view, challenge-started, challenge-completion, challenge-unlock, community-visit, parental-approval-requested, parental-approval-approved, parental-approval-rejected, custom, game-started, game-completed, leaderboard-finish, invite-admin-user, points-credit, points-spend, post-comment, post-like, post-view, reward-redemption, reward-allocation-purchase, reward-giveaway-winner, reward-claim, reward-distribution, manual-distribution, referral-link-used, shop-purchase, share-challenge-details, share-challenge-results, share-community, share-reward, share-post, share-profile, share-anything, streak-extended, profile-picture-added, bio-added, variable-captured, xp-gained, xp-total, xp-leaderboard-topper The custom events that trigger the streak to be extended for a user.
Response
Successful response
A streak config
The id of the streak config
The id of the organisation this streak config belongs to
Whether the streak is enabled and users can start and extend streaks.
Show child attributes
Show child attributes
The Nudj platform events that trigger the streak to be extended for a user. For example, challenge completions.
Available options:
achievement-completion, facebook-comment, facebook-follow, facebook-like, image-analysis-object-detection, image-analysis-receipt-detection, instagram-follow, instagram-like, instagram-comment, instagram-share, instagram-post, interaction-engage-with-content, interaction-external-link, interaction-image-upload, interaction-spot-object, platform-comment-on-post, platform-complete-achievement, platform-generative-action, platform-like-post, platform-play-game, platform-validate-event, question-multiple-choice, question-open-ended, question-rate-your-experience, question-secret-access-code, question-select-date, question-select-from-images, question-select-value-in-range, question-select-from-list, question-closed-ended, question-vote, spotify-follow, spotify-listen, spotify-save, tiktok-follow, tiktok-watch, tiktok-post, youtube-like, youtube-comment, youtube-subscribe, action-completion, skip-action, 42-school, api-auth-link, api-token-link, apple, asgardeo, atlassian, auth0, authentik, azure-ad-b2c, azure-ad, azure-devops, battlenet, beyondidentity, box, boxyhq-saml, bungie, click-up, cognito, coinbase, descope, discord, dribbble, dropbox, duende-identity-server6, email, eveonline, facebook, faceit, foursquare, freshbooks, fusionauth, github, gitlab, google, hubspot, identity-server4, instagram, kakao, keycloak, line, linkedin, mailchimp, mailru, mastodon, mattermost, medium, naver, netlify, notion, okta, onelogin, organisation-oidc, osso, osu, passage, patreon, pinterest, pipedrive, reddit, salesforce, slack, spotify, strava, tiktok, todoist, trakt, twitch, twitter, united-effects, vk, wikimedia, wordpress, workos, yandex, youtube, zitadel, zoho, zoom, blog-comment, blog-like, blog-share, blog-view, challenge-started, challenge-completion, challenge-unlock, community-visit, parental-approval-requested, parental-approval-approved, parental-approval-rejected, custom, game-started, game-completed, leaderboard-finish, invite-admin-user, points-credit, points-spend, post-comment, post-like, post-view, reward-redemption, reward-allocation-purchase, reward-giveaway-winner, reward-claim, reward-distribution, manual-distribution, referral-link-used, shop-purchase, share-challenge-details, share-challenge-results, share-community, share-reward, share-post, share-profile, share-anything, streak-extended, profile-picture-added, bio-added, variable-captured, xp-gained, xp-total, xp-leaderboard-topper The custom events that trigger the streak to be extended for a user.
The admin user who created this streak config
The admin user who last updated this streak config
The id of the community this streak config belongs to. No community means this is an organisation level streak config.
Was this page helpful?
⌘I