Events

Manages events

Get all events

Returns all the events, both public and private, that a user has permission to access. An event will only include the necessary data needed to launch the event, under the 'launchContext' field, if it is live.

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

Authorization

BearerAuthApiKeyAuth

Header parameters

Response

2004XX

The response for GET /events, an array of all events a user has permission to access

Body

application/json

title*string

eventId*string

worldIdstring

The ID of the world that the user will enter upon launching the event

scheduleobject

videoStreamobject

pictureUrlstring

The URL of the thumbnail for the event

isPublicboolean

Defines whether the event is publicly visible or not. If true, the event will be visible by all users, but only users with the necessary permissions will be able to launch into the event.

descriptionstring

remoteViewersobject

dataobject

Defines custom data of an arbitrary shape you can use to store any data you want

ubitusEventobject

launchContextobject

Defines the data needed to launch into the world linked to the 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
    },
    "ubitusEvent": {
      "specId": "text",
      "minCapacity": 0,
      "maxCapacity": 0
    },
    "launchContext": {
      "launchContextId": "text",
      "errorPageUrl": "text",
      "okPageUrl": "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,
        "allowIos": false
      },
      "bypassBrowserRestrictions": false,
      "isPublic": false,
      "projectId": "text",
      "organizationId": "text",
      "worldId": "text"
    },
    "canUserWrite": false
  }
]

Create an event

Creates an event in the organization specified in the headers

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

Authorization

BearerAuthApiKeyAuth

Header parameters

Body

application/json

title*string

worldIdstring

The ID of the world that the user will enter upon launching the event

scheduleobject

videoStreamobject

pictureUrlstring

The URL of the thumbnail for the event

isPublicboolean

Defines whether the event is publicly visible or not. If true, the event will be visible by all users, but only users with the necessary permissions will be able to launch into the event.

descriptionstring

remoteViewersobject

dataobject

Defines custom data of an arbitrary shape you can use to store any data you want

ubitusEventobject

Response

2014XX

The response for POST /events, an eventId representing the created event

Body

application/json

eventId*string

The ID of the created 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"
}

Service health check

Checks the health of the events service. Returns 'OK' and a status code of 200 if the service is healthy.

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

Response

200

Provides information about the service status.

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 publicly visible events

Returns all publicly visible events for an organization without requiring authentication, where a public event is one in which the isPublic field on the event is set to true

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

Header parameters

Response

2004XX

The response for GET /events/public, an array of public events

Body

application/json

title*string

eventId*string

worldIdstring

The ID of the world that the user will enter upon launching the event

scheduleobject

videoStreamobject

pictureUrlstring

The URL of the thumbnail for the event

isPublicboolean

Defines whether the event is publicly visible or not. If true, the event will be visible by all users, but only users with the necessary permissions will be able to launch into the event.

descriptionstring

remoteViewersobject

dataobject

Defines custom data of an arbitrary shape you can use to store any data you want

ubitusEventobject

isPublic*enum

true

canUserWrite*boolean

Whether the user can write to the event

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
    },
    "ubitusEvent": {
      "specId": "text",
      "minCapacity": 0,
      "maxCapacity": 0
    },
    "canUserWrite": false
  }
]

Get an event

Returns the event with the given ID. This endpoint will only return the necessary data needed to launch the event under the 'launchContext' field if it is live.

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

Authorization

BearerAuthApiKeyAuth

Path parameters

eventId*string

The ID of the event to retrieve

Header parameters

Response

2004XX

The response for GET /event/:eventId endpoint

Body

application/json

title*string

eventId*string

worldIdstring

The ID of the world that the user will enter upon launching the event

scheduleobject

videoStreamobject

pictureUrlstring

The URL of the thumbnail for the event

isPublicboolean

Defines whether the event is publicly visible or not. If true, the event will be visible by all users, but only users with the necessary permissions will be able to launch into the event.

descriptionstring

remoteViewersobject

dataobject

Defines custom data of an arbitrary shape you can use to store any data you want

ubitusEventobject

launchContextobject

Defines the data needed to launch into the world linked to the 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
  },
  "ubitusEvent": {
    "specId": "text",
    "minCapacity": 0,
    "maxCapacity": 0
  },
  "launchContext": {
    "launchContextId": "text",
    "errorPageUrl": "text",
    "okPageUrl": "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,
      "allowIos": false
    },
    "bypassBrowserRestrictions": false,
    "isPublic": false,
    "projectId": "text",
    "organizationId": "text",
    "worldId": "text"
  },
  "canUserWrite": false
}

Update an event

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

Authorization

BearerAuthApiKeyAuth

Path parameters

eventId*string

The ID of the event to update

Header parameters

Body

application/json

titlestring

worldIdany of

stringnull

scheduleany of

objectnull

videoStreamany of

objectnull

pictureUrlstring

The URL of the thumbnail for the event

isPublicboolean

Defines whether the event is publicly visible or not. If true, the event will be visible by all users, but only users with the necessary permissions will be able to launch into the event.

descriptionany of

stringnull

remoteViewersany of

objectnull

dataany of

objectnull

ubitusEventobject

Response

2044XX

Default Response

Body

application/json

any

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

4XX

{
  "error": "text",
  "code": "text",
  "message": "text",
  "statusCode": 0
}

Delete an event

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

Authorization

BearerAuthApiKeyAuth

Path parameters

eventId*string

The ID of the event to delete

Header parameters

Response

2044XX

Default Response

Body

application/json

any

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

4XX

{
  "error": "text",
  "code": "text",
  "message": "text",
  "statusCode": 0
}

Updates the thumbnail for an event

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

Authorization

BearerAuth

Path parameters

eventId*string

The ID of the event to update

Header parameters

Response

2005034XX

The picture url of an event

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"
}

Get the data needed to launch into the world linked to an event

Returns the launchContext for an event, which defines all the data needed to launch the event, either by downloading the world or by launching the world in a browser.

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

Authorization

BearerAuth

Path parameters

eventId*string

ID of the target event for launch context retrieval

Header parameters

Response

2004XX

The response when retrieving a launch context linked to an event

Body

application/json

launchContextId*string

errorPageUrlstring

Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context errors out

Pattern: ^https?://.*$

okPageUrlstring

Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context finishes successfully

Pattern: ^https?://.*$

gdnStreamingany of

objectnull

ubitusStreamingany of

objectnull

streamManagerany of

objectnull

enableQueueboolean

capacityany of

numbernull

isActive*boolean

Defines whether the launch context is live

buildInfoany of

objectnull

publicDownloadany of

objectnull

bypassBrowserRestrictionsboolean

Different streaming services have different restrictions on which browsers they support. Whether a user can access the stream based on their browser is determined on the client. If set to 'true', the user will be able to access the stream regardless of their browser, provided the client is set up to support this functionality.

isPublicboolean

Defines whether the event is publicly accessible or not. If true, the event can be launched by a user regardless of their permissions.

projectId*string

organizationId*string

worldId*string

The ID of the world that the user will enter upon launching the event

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",
  "okPageUrl": "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,
    "allowIos": false
  },
  "bypassBrowserRestrictions": false,
  "isPublic": false,
  "projectId": "text",
  "organizationId": "text",
  "worldId": "text"
}