events

Manages events

Experimental feature: this API is likely to change.

Service health check

GEThttps://your-organization-id.m2worlds.io/api/events/healthz

Response

200

Default Response

Body

application/json

statusMessage (string)

Provides information about the service status.

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/events/healthz', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

text

Get all events a user has permission to access

GEThttps://your-organization-id.m2worlds.io/api/events/

Authorization

BearerAuthApiKeyAuth

Header parameters

Response

2004XX

Default Response

Body

application/json

title*string

eventId*string

worldIdstring

scheduleobject

videoStreamobject

pictureUrlstring

isPublicboolean

descriptionstring

remoteViewersobject

dataobject

launchContextobject

Structure of the launch context on an event

canUserWrite*boolean

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/events/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text"
    },
});
const data = await response.json();

Response

2004XX

[
  {
    "title": "text",
    "eventId": "text",
    "worldId": "text",
    "schedule": {
      "startTime": 0,
      "endTime": 0
    },
    "videoStream": {
      "millicast": {
        "accountId": "text",
        "streamName": "text"
      },
      "youtubeUrl": "text",
      "activeService": "MILLICAST"
    },
    "pictureUrl": "text",
    "isPublic": false,
    "description": "text",
    "remoteViewers": {
      "enabled": false,
      "stateUpdateRefreshSeconds": 0
    },
    "launchContext": {
      "launchContextId": "text",
      "errorPageUrl": "text",
      "gdnStreaming": {
        "cmsId": "text",
        "authorizationId": "text",
        "launchMode": "same-tab",
        "useCustomClient": false,
        "useWindowedMode": false
      },
      "ubitusStreaming": {
        "gameLabel": "text",
        "gameChannel": "text"
      },
      "streamManager": {
        "streamContextId": "text",
        "allowForceProvider": false,
        "showProviderOptions": false,
        "useBuildVersion": false
      },
      "enableQueue": false,
      "capacity": 0,
      "isActive": false,
      "buildInfo": {
        "buildChannelId": "text",
        "buildTag": "text",
        "buildType": "client"
      },
      "publicDownload": {
        "enabled": false,
        "enforceAntiCheat": false,
        "allowMac": false
      },
      "bypassBrowserRestrictions": false,
      "isPublic": false,
      "projectId": "text",
      "organizationId": "text"
    },
    "canUserWrite": false
  }
]

Creates an event

POSThttps://your-organization-id.m2worlds.io/api/events/

Authorization

BearerAuthApiKeyAuth

Header parameters

Body

application/json

title*string

worldIdstring

scheduleobject

videoStreamobject

pictureUrlstring

isPublicboolean

descriptionstring

remoteViewersobject

dataobject

Response

2014XX

Default Response

Body

application/json

eventId*string

The ID of an event

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/events/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "title": "text"
    }),
});
const data = await response.json();

Response

2014XX

{
  "eventId": "text"
}

Gets all public events for an organization; does not require auth

GEThttps://your-organization-id.m2worlds.io/api/events/public/

Header parameters

Response

2004XX

Default Response

Body

application/json

title*string

eventId*string

worldIdstring

scheduleobject

videoStreamobject

pictureUrlstring

isPublicboolean

descriptionstring

remoteViewersobject

dataobject

isPublic*enum

true

canUserWrite*boolean

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/events/public/', {
    method: 'GET',
    headers: {
      "x-m2-organization-id": "text"
    },
});
const data = await response.json();

Response

2004XX

[
  {
    "title": "text",
    "eventId": "text",
    "worldId": "text",
    "schedule": {
      "startTime": 0,
      "endTime": 0
    },
    "videoStream": {
      "millicast": {
        "accountId": "text",
        "streamName": "text"
      },
      "youtubeUrl": "text",
      "activeService": "MILLICAST"
    },
    "pictureUrl": "text",
    "isPublic": true,
    "description": "text",
    "remoteViewers": {
      "enabled": false,
      "stateUpdateRefreshSeconds": 0
    },
    "canUserWrite": false
  }
]

Get an event

GEThttps://your-organization-id.m2worlds.io/api/events/{eventId}/

Authorization

BearerAuthApiKeyAuth

Path parameters

eventId*string

The ID of an event

Header parameters

Response

2004XX

Default Response

Body

application/json

title*string

eventId*string

worldIdstring

scheduleobject

videoStreamobject

pictureUrlstring

isPublicboolean

descriptionstring

remoteViewersobject

dataobject

launchContextobject

Structure of the launch context on an event

canUserWrite*boolean

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/events/{eventId}/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text"
    },
});
const data = await response.json();

Response

2004XX

{
  "title": "text",
  "eventId": "text",
  "worldId": "text",
  "schedule": {
    "startTime": 0,
    "endTime": 0
  },
  "videoStream": {
    "millicast": {
      "accountId": "text",
      "streamName": "text"
    },
    "youtubeUrl": "text",
    "activeService": "MILLICAST"
  },
  "pictureUrl": "text",
  "isPublic": false,
  "description": "text",
  "remoteViewers": {
    "enabled": false,
    "stateUpdateRefreshSeconds": 0
  },
  "launchContext": {
    "launchContextId": "text",
    "errorPageUrl": "text",
    "gdnStreaming": {
      "cmsId": "text",
      "authorizationId": "text",
      "launchMode": "same-tab",
      "useCustomClient": false,
      "useWindowedMode": false
    },
    "ubitusStreaming": {
      "gameLabel": "text",
      "gameChannel": "text"
    },
    "streamManager": {
      "streamContextId": "text",
      "allowForceProvider": false,
      "showProviderOptions": false,
      "useBuildVersion": false
    },
    "enableQueue": false,
    "capacity": 0,
    "isActive": false,
    "buildInfo": {
      "buildChannelId": "text",
      "buildTag": "text",
      "buildType": "client"
    },
    "publicDownload": {
      "enabled": false,
      "enforceAntiCheat": false,
      "allowMac": false
    },
    "bypassBrowserRestrictions": false,
    "isPublic": false,
    "projectId": "text",
    "organizationId": "text"
  },
  "canUserWrite": false
}

Patch an event

PATCHhttps://your-organization-id.m2worlds.io/api/events/{eventId}/

Authorization

BearerAuthApiKeyAuth

Path parameters

eventId*string

The ID of an event

Header parameters

Body

application/json

titlestring

worldIdany of

stringnull

scheduleany of

objectnull

videoStreamany of

objectnull

pictureUrlstring

isPublicboolean

descriptionany of

stringnull

remoteViewersany of

objectnull

dataany of

objectnull

Response

2044XX

Default Response

Body

application/json

object

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/events/{eventId}/', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

2044XX

{}

Delete an event

DELETEhttps://your-organization-id.m2worlds.io/api/events/{eventId}/

Authorization

BearerAuthApiKeyAuth

Path parameters

eventId*string

The ID of an event

Header parameters

Response

2044XX

Default Response

Body

application/json

object

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/events/{eventId}/', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text"
    },
});
const data = await response.json();

Response

2044XX

{}

Updates the picture URL of an event

PATCHhttps://your-organization-id.m2worlds.io/api/events/{eventId}/pictureUrl/

Authorization

BearerAuth

Path parameters

eventId*string

The ID of an event

Header parameters

Response

2005034XX

Default Response

Body

application/json

pictureUrl*string

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/events/{eventId}/pictureUrl/', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text"
    },
});
const data = await response.json();

Response

2005034XX

{
  "pictureUrl": "text"
}

Gets the launch context associated with an event

GEThttps://your-organization-id.m2worlds.io/api/events/{eventId}/launchContext/

Authorization

BearerAuth

Path parameters

eventId*string

The ID of an event

Header parameters

Response

2004XX

Default Response

Body

application/json

launchContextId*string

errorPageUrlstring

gdnStreamingany of

objectnull

ubitusStreamingany of

objectnull

streamManagerany of

objectnull

enableQueueboolean

capacityany of

numbernull

isActive*boolean

buildInfoany of

objectnull

publicDownloadany of

objectnull

bypassBrowserRestrictionsboolean

isPublicboolean

projectId*string

organizationId*string

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/events/{eventId}/launchContext/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text"
    },
});
const data = await response.json();

Response

2004XX

{
  "launchContextId": "text",
  "errorPageUrl": "text",
  "gdnStreaming": {
    "cmsId": "text",
    "authorizationId": "text",
    "launchMode": "same-tab",
    "useCustomClient": false,
    "useWindowedMode": false
  },
  "ubitusStreaming": {
    "gameLabel": "text",
    "gameChannel": "text"
  },
  "streamManager": {
    "streamContextId": "text",
    "allowForceProvider": false,
    "showProviderOptions": false,
    "useBuildVersion": false
  },
  "enableQueue": false,
  "capacity": 0,
  "isActive": false,
  "buildInfo": {
    "buildChannelId": "text",
    "buildTag": "text",
    "buildType": "client"
  },
  "publicDownload": {
    "enabled": false,
    "enforceAntiCheat": false,
    "allowMac": false
  },
  "bypassBrowserRestrictions": false,
  "isPublic": false,
  "projectId": "text",
  "organizationId": "text"
}