Pulsoid API Documentation
DashboardRequest CredentialsDiscord
  • Intro
  • Access Token Management
    • OAuth2 Implicit Grant
    • OAuth2 Authorization Code Grant
    • OAuth2 Client Credentials Grant Type(server token)
    • Manual Token Issuing
    • OAuth2 Refreshing the token
    • Revoke authorization token
    • Validate authorization token
    • List of supported scopes
  • Read Heart Rate
    • Read Latest Heart Rate via HTTP
    • Read Heart Rate via WebSocket
    • Page
    • Read Statistics
  • Widgets Management
    • Widget Entity
    • Create Widget
    • Read Widget
    • Update Widget
  • Read Profile Information
  • Error Code Format
  • VRChat
    • VRChat World Integration
Powered by GitBook
On this page
  1. Widgets Management

Widget Entity

Entity Parameters:

name
type
description

id

string

Identifier of the widget

meta_id

string

Meta identifier of the widget, encodes type of the widget

configuration

json

Valid json, encodes widget's configuration. Exact scheme of configuration is derived from the meta id.

name

string

The widget's name

Entity Example

{
  "id": "95680ad2-8d19-44fe-996c-280db1bd6bf1",
  "meta_id": "f0654a12-3a59-4beb-b567-c5febda19c48",
  "configuration": {
    "ranges": [
      {
        "to": 90,
        "from": 60,
        "color": "#04bbafff"
      },
      {
        "to": 100,
        "from": 91,
        "color": "#fdb008ff"
      }
    ],
    "heartColor": "#f72d21ff",
    "heartEnabled": true
  },
  "name": "Some name"
}
PreviousRead StatisticsNextCreate Widget

Last updated 6 months ago