Get paginated events

curl --request GET \
  --url https://{subdomain}.nudj.cx/api/v2/integration/events \
  --header 'x-api-token: <api-key>'

{
  "totalCount": 123,
  "edges": [
    {
      "id": "<string>",
      "eventCategory": "achievement",
      "eventSubCategory": "achievement-completion",
      "createdAt": "<string>",
      "organisationId": "<string>",
      "communityId": "<string>",
      "userId": "<string>",
      "eventSourceId": "<string>",
      "payload": {
        "name": "<string>"
      },
      "tags": [
        "<string>"
      ]
    }
  ]
}

Events

Get paginated events

Retrieve a paginated list of events.

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
eventCategory: string - Filter by event category
eventSubCategory: string - Filter by event subcategory
communityId: string - Filter by community ID
eventName: string - Filter by event name
fromDate: string - Filter events from this date (inclusive) (ISO 8601 format). Invalid dates are ignored.
toDate: string - Filter events until this date (inclusive) (ISO 8601 format). Invalid dates are ignored.
sort: string - Sort events by field and direction
- Supported values: createdAt:asc, createdAt:desc
- Default: createdAt:desc

GET

events

Get paginated events

curl --request GET \
  --url https://{subdomain}.nudj.cx/api/v2/integration/events \
  --header 'x-api-token: <api-key>'

{
  "totalCount": 123,
  "edges": [
    {
      "id": "<string>",
      "eventCategory": "achievement",
      "eventSubCategory": "achievement-completion",
      "createdAt": "<string>",
      "organisationId": "<string>",
      "communityId": "<string>",
      "userId": "<string>",
      "eventSourceId": "<string>",
      "payload": {
        "name": "<string>"
      },
      "tags": [
        "<string>"
      ]
    }
  ]
}

Authorizations

x-api-token

string

header

required

Query Parameters

limit

integer

default:10

Required range: 1 <= x <= 100

skip

integer

default:0

Required range: x >= 0

sort

string

communityId

string

allocationId

string

featured

boolean

verified

boolean

isShop

boolean

type

string

status

string

eventCategory

string

eventSubCategory

string

eventName

string

displayMode

string

fromDate

string

toDate

string

isGlobalTemplate

boolean

key

string

progressPeriod

string

Response

Successful response

totalCount

number

required

edges

Event · object[]

required

Show child attributes

edges.id

string

required

The id of the event

edges.eventCategory

enum<string>

required

The category of the event

Available options:

achievement,

action,

auth,

blog,

challenge,

community,

custom,

game,

leaderboard,

organisation,

points,

post,

referral,

reward,

shop,

social,

social-connection,

streak,

user,

variable,

xp

edges.eventSubCategory

enum<string>

required

The sub-category of the event

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

edges.createdAt

string

required

The date when the event was created

edges.organisationId

string | null

The organisation that the event belongs to

edges.communityId

string | null

The community that the event belongs to

edges.userId

string | null

The user that the event belongs to

edges.eventSourceId

string | null

The Id of an entity that is associated with this event. For example, a challenge or an achievement

edges.payload

Custom Event · object

The payload of the event

Custom Event
Achievement Completed Event
Challenge Completed Event
Challenge Started Event
Game Started Event
Game Completed Event
Referral Link Used Event
Reward Redeemed Event
Reward Claimed Event
Reward Distributed Event
Xp Gained Event
Organisation Invite User Event
Auth Email Event
Post Like Event
Post Comment Event
Variable Captured Event
Streak Extended Event
Manual Reward Distribution Event
Leaderboard Finish Event
Shop Purchase Event

Show child attributes

edges.payload.name

string

required

The name of the custom event

edges.tags

string[] | null

The tags associated with the event

Get community by ID or slug Claim an event token

⌘I

Achievements

Action Participations

Actions

Auth Config

Campaigns

Challenge Groups

Challenges

Comments

Communities

Events

Feature Flags

Languages

Leaderboards

Legal Policies

Me

Posts

Rewards

Tags

Themes

Third Party Config

Variables

Get paginated events

Authorizations

Query Parameters

Response