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

Create Widget

PreviousWidget EntityNextRead Widget

Last updated 6 months ago

This method allows the creation of the .

Request

name
value

url

https://dev.pulsoid.net/api/v1/widgets

method

POST

scope

widgets:update

Body Param Accepts JSON object with the following fields

name
value

configuration

Json representing new widget's configuration

name

Name of the widget

meta_id

Currently only basic bpm is supported so the value should be hardcoded to bf6bdf21-10a7-4a28-97ec-a239e6c77f8b

Headers Parameters explained:

name
value
description

Authorization

Bearer {auth token}

Response

The response is a created .

Curl Request Example

curl --request POST \
  --url https://pulsoid.net/api/v1/widgets \
  --header 'Authorization: Bearer 47ee2a9f-624d-4ed3-84db-8104b229f21c' \
  --header 'Content-Type: application/json' \
  --data '{
  "meta_id": "bf6bdf21-10a7-4a28-97ec-a239e6c77f8b",
  "name": "Test",
  "configuration": {
    "heartEnabled": false
  }
}'

Response Example

{
  "widget": {
    "id": "a9b9768c-b907-40b7-9530-ae515d8df6b0",
    "meta_id": "bf6bdf21-10a7-4a28-97ec-a239e6c77f8b",
    "configuration": {
      "heartEnabled": false
    },
    "name": "Test"
  }
}

How to obtains access token

widget
widget
https://docs.pulsoid.net/#how-to-obtain-an-authorization-token