Community activity notification API
The Community Activity Notification API allows game studios to receive the PlayerID of a user when they post on a specific board in the community.
Overview¶
When a game studio registers an API endpoint to receive PlayerIDs in the Hive Console, Hive Community will send the PlayerID of the post or comment author to this endpoint. This can be used to integrate Hive Community with the game server to connect user community activities with in-game reward systems and more.
Here is how to use it:
-
Game studio: Register an API endpoint (callback URL) in Hive Console Community & Web Shop > Community UI > Game Integration > Notification Settings.
- The callback URL format can be freely configured by the game studio
- Other API specifications should follow the API Request Configuration and API Response Configuration sections below
-
Hive Community server: When a user posts on a specific board or leaves a comment, the PlayerID of the author is sent to the game server as a callback (with
player_idin the Request body). - Game studio: Use this PlayerID freely for various in-game events, quest reward logic, and more.
Prerequisites¶
API Request (Hive Server → Game Server) Configuration¶
This is the POST request information sent from the Hive server to the game server.
Request header¶
| API Info | Description |
|---|---|
| Method | POST |
| Response Format | JSON |
| Content-type | application/json |
Request body¶
| Name | Type | Required (Required: O, Optional: X) | Description |
|---|---|---|---|
| player_id | Integer | O | User unique identifier |
| lang | String | O | Board language |
| board_idx | Integer | O | Board IDX |
| board_name | String | O | Board name |
| write_type | String | O | Post type (board: post, comment: comment) |
| reg_date | String | O | Callback time |
Request body sample¶
{
"player_id" : 20000010000,
"lang" : "ko",
"board_idx" : 12345,
"board_name" : "Event",
"write_type" : "board",
"reg_date" : "2025-08-14 10:12:18"
}
API Response (Game Server → Hive Server) Configuration¶
This is the response information sent from the game server to the Hive server.
Response body¶
- Data type: JSON
- Parameters
| Name | Type | Description |
|---|---|---|
| result_code | Integer | Result code (100: Success) |
| result_msg | String | Result message |
Response Code¶
| HTTP Status Code | Code | Message | Description |
|---|---|---|---|
| 200 | 100 | Success. | Success |
- Success must be sent as 100.
