About Forge Direct API

The Forge Direct API allows you to programmatically manage and interact with a game or community powered by the Forge Platform

๐ŸŽฎ Game & User Management

Manage Game Info: Retrieve and update your game's details, such as its title, description, and social media links.

Access User Data: Get detailed information about users, including their profiles, current points, lifetime points, and daily streaks.

Track User Activity: Retrieve a list of all users and track quest completions and purchases.

User Communication: Send messages directly to a user's inbox or broadcast messages to all active users.


๐Ÿ† Quests & Rewards

Create and Manage Quests: Create new quests from available templates (like quizzes or social actions) and manage existing ones by updating their details, points, or start/end times.

Automate Progress: Programmatically mark quests as completed for a user or trigger a manual sync to check for progress.

Manage Rewards: Create and manage custom rewards with unique codes that can be distributed to users.

Distribute Points: Manually give bonus points to a specific user.


๐ŸŽŸ๏ธ Events & Products

Run Raffles: Create new raffles, get a list of participants or winners, and distribute rewards.

Manage Products: Create new products in the in-game shop, manage their stock (codes), and distribute them to users.

Track Transactions: View a history of all raffle ticket purchases and product purchases.


๐Ÿ“Š Segmentation & Analytics

Create User Segments: Create custom user groups based on usernames to target them for specific campaigns.

Manage Segments: Add or remove users from a segment and send messages to an entire group at once.

Access Leaderboards: Retrieve the campaign's points leaderboard to see how users rank.

Track Requests: Check the status of asynchronous API requests to ensure actions like point distribution or quest syncs have been completed successfully.


๐Ÿ‘คUser Quests & Actions

Get Quests: Retrieve a list of quests assigned to a user, or get specific details for an individual quest.

Quest Completion: Manually mark a quest as completed for a specific user.

Perform Actions: For the authenticated user (using a JWT), you can perform quest-related actions like posting, replying, or quoting content.

Record Responses: Record a user's selection for a quiz or surprise quest, and receive a response indicating points earned and whether the answer was correct.

Sync Progress: Trigger a manual sync of a user's quest progress to ensure their status is up-to-date.