Events

The event model

Three kinds of event, the clock they run on, and what joining changes.

What an event is made of, and the vocabulary the other four pages use.

An event

A competition with a start and an end. Fans join, compete for a fixed period, and are paid by where they finish or by what the community achieved together.

A quest is something one fan does. An event is something a crowd does at the same time, which is why it comes with a clock, a participant count and its own leaderboard.

Events are created in the Hub: the type, the window, the quests inside and the prizes. Events in the Hub docs covers that side. This section is about rendering what your team built.

Three types

QUEST_EVENT_TYPEWhat fans doHow it is decided
BASICComplete the event's questsPoints from those quests rank the leaderboard
SCOREPlay a linked game or platformPoints are read from the linked account and ranked
COLLABORATIVEComplete quests towards one shared targetThe whole community wins or loses together

The type decides what the middle of your event page shows. A BASIC or COLLABORATIVE event has a quest list. A SCORE event has a scoring table instead, because its quests are scoring rules rather than things to submit.

The clock

Every event carries up to four dates.

FieldMeans
registrationStartDateWhen fans can start joining. Before startDate, joining is pre-registration.
startDateWhen the event goes live
registrationEndDateThe last moment to join. When it is absent, fans can join until the end.
endDateWhen the event stops

You never compare these to the current time yourself. The SDK derives a time badge, a join deadline and three timeline tiles from them, and tells you which state each is in. The event page shows how.

Statuses

QUEST_EVENT_STATUSMeansWhere it lists
DRAFTNot publishedNowhere. The list never returns drafts.
PUBLISHEDOpen to fansUpcoming, live or finished, by its dates
RESOLVINGEnded, results being worked outFinished
COMPLETEDEnded and resolved. Rewards can be claimed.Finished
CANCELLEDCalled offFinished

Rewards exist only once an event is COMPLETED. An event that has passed its end date but is still PUBLISHED or RESOLVING has ended for fans, and has nothing to claim yet.

Joining

A fan who has joined is REGISTERED. That one status unlocks everything personal about the event: their quests count, their rank loads, and the event shows on their profile.

participation.statusTreated as
REGISTEREDJoined
UNREGISTERED, DROPPED, CANCELLEDNot joined

There is no leave button in the SDK. Joining is one way.

An event can ask for something before a fan joins:

RequirementWhat it asks for
membership_tierA membership tier. A Premium fan passes a Premium gate; a free fan does not. Membership.
quest_completedOne named quest finished first

A SCORE event can also need a linked account, because that is where the score comes from. Joining covers each refusal and what to show for it.

What the SDK gives you

One provider for an event page, QuestEvent.Provider, and hooks for the list. The provider reads the event, the fan's participation, the leaderboard, their rank and their rewards, and hands you one state object that already says which button to show.

The compound is called QuestEvent, not Event. Event is the browser's own global, and shadowing it breaks unrelated code.

There is no separate request for an event's quests. They arrive inside the event.

The four pages

PageCovers
The event pageListing events, mounting one, the header, tabs and timeline
JoiningThe one button, its ten states, and every refusal
PlayingQuests inside an event, the scoring table, community progress
Results and rewardsThe leaderboard, the fan's rank, prize distribution and claims

On this page