AppHub Tether
Inbox
Drains the Tether Link inbox — returns and clears all pending social events (game invites and responses) queued by the launcher for your app. Poll every 3–5 seconds during active multiplayer sessions.
GET
http://127.0.0.1:7420/inbox
This endpoint requires AppHub Store to be running on your machine. The live tester calls your local AppHub instance directly.
Query parameters
| Parameter | Required | Description |
|---|---|---|
| appid | required | Your app's packagename |
Test this endpoint
Headers
Query Parameters
Success response 200
{
"ok": true,
"appid": "com.studio.mygame",
"events": [
{
"type": "game_invite",
"room_data": { "room": "sala-42", "host": "192.168.1.5" },
"ts": 1747012345678
},
{
"type": "game_invite_accepted",
"from_user_id": 10,
"from_username": "amigo1",
"ts": 1747012400000
}
]
}Response fields
| Field | Type | Description |
|---|---|---|
| ok | boolean | Always true if the request succeeded |
| appid | string | Echoes back the requested packagename |
| events | array | Pending events. The queue is cleared on read. Empty array if none. |
Event types
| type | Direction | Description |
|---|---|---|
game_invite | Incoming | A friend invited you — room_data contains the join payload sent by the inviting app |
game_invite_accepted | Response to your invite | A friend accepted an invite you sent via POST /invite |
game_invite_declined | Response to your invite | A friend declined an invite you sent via POST /invite |
Notes
| Detail | Description |
|---|---|
| Poll interval | Poll every 3–5 seconds during an active multiplayer session. Stop polling when no session is active. |
| Queue limit | The launcher holds at most 20 events per app. Older events are discarded if the queue overflows. |
room_data: null | When an invite was sent from the AppHub launcher UI (not from code), room_data will be null. Handle by generating a new room rather than trying to join an existing one. |