XRCLOUD API (1.1)

All API calls in this document require an ApiKey.

• You can obtain the ApiKey from My page in the upper right corner after logging into the XRCLOUD page.

XRCLOUD delivers event logs to the configured webhook URL whenever specific Room and Scene events occur.

Room Events

• room-join: User enters a Room
• room-exit: User exits a Room
• room-video-click-event: Video click event in Room

Scene Events

• scene-created: Scene creation
• scene-updated: Scene modification

Webhook Request Information

• Method: POST
• Headers:
  • Content-Type: application/json
  • X-Forwarded-For: User IP

Request Data Format

{
  "code": "room-join",              // Type of event that occurred
  "resourceId": "uuid",            // Room/Scene ID
  "sessionId": "uuid",             // Session ID
  "reticulumId": "string",         // XRCLOUD(Hubs) user ID
  "logTime": "2024-01-01T00:00:00Z", // Timestamp when the event occurred
  "action": "string",              // Specific action performed (e.g., "enter", "exit")
  "ip": "string",                  // User IP (extracted from X-Forwarded-For header)
  "userAgent": "string",           // User browser information
  "device": "string"               // User's device type (pc/mobile/vr)
}```

**Note**: 
- The webhook URL can be set when creating or modifying a Project.
- Currently, ip and userAgent values may not be transmitted correctly.
- If the webhook request response returns a status code of 300 or higher, it will be treated as an error.

A Project in XRCLOUD can be a developer's project, platform, or 3rd-party application. It serves as a management unit for Scenes and Rooms, where multiple Scenes and Rooms can belong to a specific Project.

A space for creating web-based 3D virtual environments that are required for Room creation.

To create a Scene, call the get-creation-url api to obtain the 'sceneCreationUrl', access the editor (Spoke), and click the Publish Scene button in the upper right corner. You can also modify existing Scenes by accessing the 'sceneModificationUrl' field obtained from the get-scene api.

• The optId value is a callback value used by XRCLOUD to verify Scene creation and modification. Modifying it may cause errors.

A Room is a virtual space based on a Scene created through the editor (Spoke).

Each Room provides two types of URLs: a private room URL that changes with each request and a public room URL with a fixed address. These URLs are further divided into host URLs that grant host permissions and guest URLs that grant guest permissions.

The 'returnUrl' specifies the web address to return to when leaving the room, which can be configured in the Rooms tab of XRCloud.