Action Participations
Auth Config
Campaigns
Challenge Groups
Challenges
Feature Flags
Languages
Leaderboards
Legal Policies
Me
Posts
Third Party Config
curl --request GET \
--url https://{subdomain}.nudj.cx/api/v2/integration/actions \
--header 'x-api-token: <api-key>'{
"totalCount": 123,
"edges": [
{
"id": "<string>",
"organisationId": "<string>",
"communityId": "<string>",
"allocationId": "<string>",
"allocatedTo": "achievement",
"position": 123,
"category": "nudj",
"key": "facebook-comment",
"details": {
"title": "<string>",
"description": "<string>",
"light": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
},
"dark": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
}
},
"progressPeriod": "daily",
"maxCompletionsPerPeriod": 1,
"attributes": {
"key": "question-multiple-choice",
"question": "<string>",
"options": [
{
"id": "<string>",
"label": "<string>"
}
],
"minimumNumberOfAnswersRequired": 2,
"maximumNumberOfAnswersAllowed": 2
},
"config": {
"isOptional": true,
"socialValidation": "validation-on",
"prerequisites": {
"requiredActionCount": 123,
"actionIds": [
"<string>"
]
},
"requiresCorrectAnswer": true
},
"videoMetadata": {
"startsAtMs": 1,
"shouldPause": true,
"validatesAtMs": 1,
"endsAtMs": 1
},
"createdAt": "<string>",
"stats": {
"totalXp": 123
},
"reward": {
"points": 1,
"completionXp": 1,
"items": [
{
"id": "<string>",
"details": {
"title": "<string>",
"description": "<string>",
"light": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
},
"dark": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
}
},
"type": "assets",
"amountToDistribute": 1,
"totalSupply": 1,
"remainingSupply": 1
}
],
"rewardSelectionMethod": "all",
"numberOfRewardsToReceive": 1,
"distributionEventId": "<string>"
},
"userState": {
"status": "completed",
"criteriaMet": true,
"statusMessage": "<string>",
"eligibleXp": 123,
"earnedXp": 123,
"attempts": 123,
"output": {
"key": "interaction-external-link",
"eventId": "<string>"
},
"unmetCriteriaMessage": "<string>"
},
"participations": [
{
"id": "<string>",
"criteriaMet": true,
"output": {
"key": "interaction-external-link",
"eventId": "<string>"
},
"status": "pending",
"participatedAt": "<string>",
"processingStartedAt": "<string>",
"processedAt": "<string>",
"unmetCriteriaMessage": "<string>",
"processingFailedMessage": "<string>"
}
],
"actionGroupId": "<string>",
"actionGroupIndex": 123,
"availableAsTemplateForOrganisations": [
"<string>"
],
"isGlobalTemplate": true,
"previousAction": "<string>",
"nextAction": "<string>"
}
]
}Get paginated actions
Retrieve a paginated list of actions.
Supported query parameters:
- limit: number (1-100, default: 10) - Number of items per page
- skip: number (>= 0, default: 0) - Number of items to skip
- allocationId: string - Filter by allocation ID
curl --request GET \
--url https://{subdomain}.nudj.cx/api/v2/integration/actions \
--header 'x-api-token: <api-key>'{
"totalCount": 123,
"edges": [
{
"id": "<string>",
"organisationId": "<string>",
"communityId": "<string>",
"allocationId": "<string>",
"allocatedTo": "achievement",
"position": 123,
"category": "nudj",
"key": "facebook-comment",
"details": {
"title": "<string>",
"description": "<string>",
"light": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
},
"dark": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
}
},
"progressPeriod": "daily",
"maxCompletionsPerPeriod": 1,
"attributes": {
"key": "question-multiple-choice",
"question": "<string>",
"options": [
{
"id": "<string>",
"label": "<string>"
}
],
"minimumNumberOfAnswersRequired": 2,
"maximumNumberOfAnswersAllowed": 2
},
"config": {
"isOptional": true,
"socialValidation": "validation-on",
"prerequisites": {
"requiredActionCount": 123,
"actionIds": [
"<string>"
]
},
"requiresCorrectAnswer": true
},
"videoMetadata": {
"startsAtMs": 1,
"shouldPause": true,
"validatesAtMs": 1,
"endsAtMs": 1
},
"createdAt": "<string>",
"stats": {
"totalXp": 123
},
"reward": {
"points": 1,
"completionXp": 1,
"items": [
{
"id": "<string>",
"details": {
"title": "<string>",
"description": "<string>",
"light": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
},
"dark": {
"primaryImageUrl": "<string>",
"secondaryImageUrl": "<string>"
}
},
"type": "assets",
"amountToDistribute": 1,
"totalSupply": 1,
"remainingSupply": 1
}
],
"rewardSelectionMethod": "all",
"numberOfRewardsToReceive": 1,
"distributionEventId": "<string>"
},
"userState": {
"status": "completed",
"criteriaMet": true,
"statusMessage": "<string>",
"eligibleXp": 123,
"earnedXp": 123,
"attempts": 123,
"output": {
"key": "interaction-external-link",
"eventId": "<string>"
},
"unmetCriteriaMessage": "<string>"
},
"participations": [
{
"id": "<string>",
"criteriaMet": true,
"output": {
"key": "interaction-external-link",
"eventId": "<string>"
},
"status": "pending",
"participatedAt": "<string>",
"processingStartedAt": "<string>",
"processedAt": "<string>",
"unmetCriteriaMessage": "<string>",
"processingFailedMessage": "<string>"
}
],
"actionGroupId": "<string>",
"actionGroupIndex": 123,
"availableAsTemplateForOrganisations": [
"<string>"
],
"isGlobalTemplate": true,
"previousAction": "<string>",
"nextAction": "<string>"
}
]
}Authorizations
Headers
The language to return the actions in. If not provided, the default language for the organisation will be used.
Query Parameters
1 <= x <= 100x >= 0Response
Successful response
Show child attributes
Show child attributes
The id of the action
The organisation that the action belongs to
The community that the action belongs to
The allocation this action is assigned to. This can be set to a challenge only at the moment.
The entity type this action is allocated to. This can be set to a 'challenge' only at the moment.
achievement, action, community, challenge, post, reward, reward-asset, reward-entry The display position of this action
The category of this action
nudj, discord, facebook, imageAnalysis, instagram, interaction, linkedin, question, platform, spotify, tiktok, twitter, youtube The specific type of this action
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 The details of this action such as title, description, bannerUrl, logoUrl
Show child attributes
Show child attributes
The title of the entity
The description of the entity
The progress period of the action
daily, weekly, monthly, yearly, open The maximum number of completions per period for the action
x >= 0The specific attributes for this action type. This must symantically match the key of this action.
- Multiple Choice Question
- Open Ended Question
- Rate Your Experience Question
- Secret Access Code Question
- Select From Images Question
- Select From List Question
- Single Fixed Answer Question
- Vote Question
- Select A Date Question
- Select Value In Range Question
- External Link Interaction
- Engage With Content Interaction
- Image Upload Interaction
- Spot Object Action
- Object Detection Action Attributes
- Receipt Detection Action Attributes
- Facebook Comment Action Attributes
- Facebook Follow Action Attributes
- Facebook Like Action Attributes
- Instagram Follow Action Attributes
- Instagram Like Action Attributes
- Instagram Comment Action Attributes
- Instagram Share Action Attributes
- Instagram Post Action Attributes
- Comment On Post Action Attributes
- Complete Achievement Action Attributes
- Generative Action Attributes
- Like Post Action Attributes
- Play Game Action Attributes
- Validate Event Action Attributes
- Spotify Follow Action Attributes
- Spotify Listen Action Attributes
- Spotify Save Action Attributes
- Youtube Comment Action Attributes
- Youtube Subscribe Action Attributes
- Youtube Like Action Attributes
- TikTok Follow Action Attributes
- TikTok Post Video With Hashtag Action Attributes
- TikTok Watch Video Action Attributes
Show child attributes
Show child attributes
The multiple choice question action key
question-multiple-choice The multiple choice question to be answered ie 'What is your favorite color?'
1The multiple choice options available to answer the question
2The minimum number of answers required
x >= 1The maximum number of answers allowed
x >= 1The configuration settings for this action
Show child attributes
Show child attributes
Whether this action is optional
Controls how social media validation is handled:
- validation-on: Strict validation is enforced. The action will only be marked as complete if the social media activity is verified.
- validation-off: No validation is performed. The action is automatically marked as complete.
- user-choice: Allows users to choose whether to bypass validation by setting isBypass=true in their action input. If isBypass=false, full validation will be performed.
validation-on, validation-off, user-choice Used to configure a prerequisite for an action
Whether the action must be answered correctly to count toward challenge completion. When false, any participation counts toward completion but only correct answers earn rewards.
Video metadata for actions with video content
Show child attributes
Show child attributes
The start time of the action in milliseconds from the start of the video
x >= 0Whether the video should pause at the validation point
The validation time in milliseconds, null if the user will validate themselves
x >= 0The end time of the action in milliseconds from the start of the video
x >= 0The date when this action was created
A reward distribution for an entity
Show child attributes
Show child attributes
Number of points awarded
x >= 0Amount of XP awarded for completion
x >= 0Reward items available
Show child attributes
Show child attributes
The unique identifier of the reward
Used to describe an entity
Show child attributes
Show child attributes
The title of the entity
The description of the entity
The type of reward allocation (assets or entries)
assets, entries Amount of this reward to distribute
x >= 0Total supply available for this reward
x >= 0Number of items still available for distribution
x >= 0Method for reward selection
all, priority, random, select, Number of rewards to receive
x >= 0ID of the distribution event
Show child attributes
Show child attributes
Current progress state of the action for the user
completed, in-progress, locked, not-started, repeatable, skipped Indicates whether the user has successfully completed the action's requirements
Human-readable message explaining the current status to the user
The XP available for the user to earn. This decreases with failed attempts and becomes 0 once completed
Total XP the user has earned from this action so far
Number of times the user has attempted this action
Results from the user's most recent attempt
- ExternalLinkActionOutput
- EngageWithContentActionOutput
- ImageUploadActionOutput
- SpotObjectActionOutput
- OpenEndedActionOutput
- MultipleChoiceActionOutput
- SingleFixedAnswerActionOutput
- SelectFromImagesActionOutput
- RateYourExperienceActionOutput
- SelectFromListActionOutput
- SecretAccessCodeActionOutput
- VoteActionOutput
- SelectADateActionOutput
- SelectValueInRangeActionOutput
- ObjectDetectionActionOutput
- ReceiptDetectionActionOutput
- FacebookCommentActionOutput
- FacebookFollowActionOutput
- FacebookLikeActionOutput
- InstagramFollowActionOutput
- InstagramLikeActionOutput
- InstagramCommentActionOutput
- InstagramShareActionOutput
- InstagramPostActionOutput
- CommentOnPostActionOutput
- CompleteAchievementActionOutput
- GenerativeActionActionOutput
- LikePostActionOutput
- PlayGameActionOutput
- Validate Event Action Output
- SpotifyFollowActionOutput
- SpotifyListenActionOutput
- SpotifySaveActionOutput
- TikTokFollowActionOutput
- TikTokPostActionOutput
- TikTokWatchActionOutput
- YoutubeCommentActionOutput
- YoutubeSubscribeActionOutput
- YoutubeLikeActionOutput
Explanation of why the action requirements haven't been met, if applicable
History of all user attempts and interactions with this action
Show child attributes
Show child attributes
The output of an action.
- ExternalLinkActionOutput
- EngageWithContentActionOutput
- ImageUploadActionOutput
- SpotObjectActionOutput
- OpenEndedActionOutput
- MultipleChoiceActionOutput
- SingleFixedAnswerActionOutput
- SelectFromImagesActionOutput
- RateYourExperienceActionOutput
- SelectFromListActionOutput
- SecretAccessCodeActionOutput
- VoteActionOutput
- SelectADateActionOutput
- SelectValueInRangeActionOutput
- ObjectDetectionActionOutput
- ReceiptDetectionActionOutput
- FacebookCommentActionOutput
- FacebookFollowActionOutput
- FacebookLikeActionOutput
- InstagramFollowActionOutput
- InstagramLikeActionOutput
- InstagramCommentActionOutput
- InstagramShareActionOutput
- InstagramPostActionOutput
- CommentOnPostActionOutput
- CompleteAchievementActionOutput
- GenerativeActionActionOutput
- LikePostActionOutput
- PlayGameActionOutput
- Validate Event Action Output
- SpotifyFollowActionOutput
- SpotifyListenActionOutput
- SpotifySaveActionOutput
- TikTokFollowActionOutput
- TikTokPostActionOutput
- TikTokWatchActionOutput
- YoutubeCommentActionOutput
- YoutubeSubscribeActionOutput
- YoutubeLikeActionOutput
pending, in-progress, processed, failed The action group this action belongs to
The index of this action within its action group
List of organisation IDs that can use this action as a template
Indicates if this action is available as a template globally across all organisations
ID of the action that precedes this one in sequence
ID of the action that follows this one in sequence
Was this page helpful?