Discord Rich Presence

Get Configuration

This method allows the reading of Discord Rich Presence configuration.

Request

name	value
url	https://dev.pulsoid.net/api/v1/discord-rich-presence/configuration
method	GET
scope	discord:rich_presence:config:read

Headers Parameters explained:

name	value	description
Authorization	Bearer {auth token}	How to obtains access token https://docs.pulsoid.net/#how-to-obtain-an-authorization-token

Response

Specific Errors:

http status code	reason
404	User doesn't have any Discord Rich Presence configuration

Curl Request Example

curl --request GET \
  --url https://dev.pulsoid.net/api/v1/discord-rich-presence/configuration \
  --header 'Authorization: Bearer 47ee2a9f-624d-4ed3-84db-8104b229f21c'

Response Example

{
  "configuration": {
    "enabled": true,
    "details": "Heart Rate: {bpm} BPM",
    "state": "Streaming with Pulsoid",
    "largeImageKey": "pulsoid_logo"
  }
}

---

Update Configuration

This method allows the updating/overwriting of Discord Rich Presence configuration.

Request

name	value
url	https://dev.pulsoid.net/api/v1/discord-rich-presence/configuration
method	POST
scope	discord:rich_presence:config:write

Headers Parameters explained:

name	value	description
Authorization	Bearer {auth token}	How to obtains access token https://docs.pulsoid.net/#how-to-obtain-an-authorization-token

NOTE: This API overwrites the existing configuration, so the client should submit the full configuration every time.

Example of request body

{
  "configuration": {
    "enabled": true,
    "details": "Heart Rate: {bpm} BPM",
    "state": "Streaming with Pulsoid",
    "largeImageKey": "pulsoid_logo"
  }
}

Response

The response body in case 200 http status is the updated configuration.

Curl Request Example

curl --request POST \
  --url https://dev.pulsoid.net/api/v1/discord-rich-presence/configuration \
  --header 'Authorization: Bearer 47ee2a9f-624d-4ed3-84db-8104b229f21c' \
  --header 'content-type: application/json' \
  --data '{
  "configuration": {
    "enabled": true,
    "details": "Heart Rate: {bpm} BPM",
    "state": "Streaming with Pulsoid",
    "largeImageKey": "pulsoid_logo"
  }
}'

Response Example

{
  "configuration": {
    "enabled": true,
    "details": "Heart Rate: {bpm} BPM",
    "state": "Streaming with Pulsoid",
    "largeImageKey": "pulsoid_logo"
  }
}

---