Modbot Docs
APIAPI referenceEvents

Event polling

GET/api/events/poll

Authenticate with Authorization: Bearer mbk_.... Returns events after cursor at once when there are any, up to limit (default 100, at most 500); otherwise waits up to wait seconds (default 30, at most 60) for one and returns an empty list. No cursor means from now. Send the returned cursor back; more means poll again straight away. types and subjects repeat or are comma-separated. Field names in the answer are snake_case (type_raw, occurred_at, world_id); the keys inside an event's data are camelCase. See https://docs.modbot.co/api/long-polling/.

AuthorizationBearer <token>

An API key, made on Settings, API keys. Every key starts with mbk_.

In: header

Query Parameters

cursor?string
types?array<string>
subjects?array<string>
wait?integer
Formatint32
limit?integer
Formatint32

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/api/events/poll"
{  "events": [    {      "version": 0,      "id": "string",      "cursor": null,      "type": "string",      "type_raw": null,      "label": "string",      "category": "string",      "source": "string",      "occurred_at": "2019-08-24T14:15:22Z",      "occurred_before": null,      "observed_at": "2019-08-24T14:15:22Z",      "subject": {        "platform": "string",        "id": "string",        "kind": "string"      },      "actor": null,      "world_id": null,      "instance_id": null,      "data": null    }  ],  "cursor": "string",  "more": true,  "notice": null}

Modbot is not endorsed by or affiliated with VRChat Inc. or Discord Inc. VRChat is a trademark of VRChat Inc. Discord is a trademark of Discord Inc. SteamVR is a trademark of Valve Corporation. Windows is a trademark of Microsoft Corporation. Docker is a trademark of Docker, Inc. PostgreSQL is a trademark of the PostgreSQL Community Association of Canada. Railway is a trademark of Railway Corp. Other names are trademarks of their respective owners; see Legal. Modbot and its logo are trademarks of the Modbot project. Open source under AGPL-3.0.