Skip to content

Document InfoPush endpoint #115

@Foorack

Description

@Foorack

Paths

Endpoint /api/1/infoPush only responds on GET. No management endpoints found. Authentication required.

Known query params are include and require. include specifies which Info objects should be included, based on tags. require puts restriction that a returned Info object has that specific tag.

Data Structure

Info objects seems to always contain id, isEnabled, releaseStatus, priority, tags, data, hash, createdAt and updatedAt.
Hash is MD5, meaning is unknown.
Priority is sort-order in-game.
"Data" field can contain any fields, such as "imageUrl", "onPressed"," or "version" or "contentList". No assumptions can be made if that is all of the fields.

{
  "id":"launch-beta",
  "isEnabled":true,
  "releaseStatus":"public",
  "priority":970,
  "tags":[
    "quick-menu-banner",
    "user-all"
  ],
  "data":{
    "imageUrl":"https://assets.vrchat.com/ips/assets/b5af844263458d3a5b3e01b52ef7fe47f7b3b563eace4ee972205f250474c879.png",
    "onPressed":{
      "command":"OpenURL",
      "parameters":[
        "https://docs.vrchat.com/v2021.4.1/docs/latest-release"
      ]
    }
  },
  "hash":"69abf85064503e870124acde330bb0ae",
  "createdAt":"2021-09-13T20:50:40+00:00",
  "updatedAt":"2021-11-08T22:45:25+00:00"
}
{
  "id":"world-hot",
  "isEnabled":true,
  "releaseStatus":"public",
  "priority":1000,
  "tags":[
    "world-category"
  ],
  "data":{
    "imageUrl":"https://assets.vrchat.com/ips/assets/40f8ad117f8d6734ac84039d8ced290b6676486099b7cc56759efe7b259ca05d.png",
    "contentList":{
      "name":"Hot",
      "sortHeading":"heat",
      "sortOwnership":"any",
      "sortOrder":"descending",
      "platform":"ThisPlatformSupported"
    }
  },
  "hash":"f0e97e72c437aa437e92c1184630bec6",
  "createdAt":"2020-06-05T08:23:31+00:00",
  "updatedAt":"2020-08-16T07:04:07+00:00"
}

Metadata

Metadata

Assignees

Labels

Priority: MediumNormal priorityType: Undocumented EndpointWow! This is new! This is unchartered terrirory and is only recommended by experienced comitters

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions