v6 documentation is incomplete, want to contribute?

Show Information Notices

IPS (Info Push System) is a system for VRChat to push out dynamic information to the client. This is primarily used by the Quick-Menu info banners, but can also be used to e.g. alert you to update your game to the latest version.

include is used to query what Information Pushes should be included in the response. If include is missing or empty, then no notices will normally be returned. This is an "any of" search.

require is used to limit what Information Pushes should be included in the response. This is usually used in combination with include, and is an "all of" search.

Requests made through this page are proxied through an intermediary server due to Cross-Origin Resource Sharing restrictions.

GET
/infoPush

Query Parameters

require?string

Tags to include (comma-separated). All of the tags needs to be present.

include?string

Tags to include (comma-separated). Any of the tags needs to be present.

Response Body

application/json

curl -X GET "https://api.vrchat.cloud/api/1/infoPush?require=string&include=string"

[
  {
    "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"
  }
]