Events

Manages events

Last updated 4 months ago

Was this helpful?

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. Accepts an optional projectId header to only fetch events from that project.

get

Authorizations

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstring

The ID of a project

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/events/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text'

200

4XX

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

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

Create an event

Creates an event in the project specified in the headers

post

Authorizations

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Body

titlestringrequired

worldIdstring

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

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

dataobject

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

scheduleobject

remoteViewersobject

ubitusEventobject

videoStreamobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://your-organization-id.m2worlds.io/api/events/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text' \
  --header 'Content-Type: application/json' \
  --data '{"title":"text","data":{"ANY_ADDITIONAL_PROPERTY":"anything"},"schedule":{"startTime":1},"remoteViewers":{"enabled":true},"ubitusEvent":{"specId":"text","minCapacity":1,"maxCapacity":1},"videoStream":{"activeService":"MILLICAST","millicast":{"accountId":"text","streamName":"text"}}}'

201

4XX

{
  "eventId": "text"
}

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

Service health check

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

get

/healthz

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/events/healthz'

200

text

Provides information about the service status.

Get all publicly visible events

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

get

/public/

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/events/public/' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text'

200

4XX

[
  {
    "title": "text",
    "eventId": "text",
    "worldId": "text",
    "pictureUrl": "text",
    "isPublic": true,
    "description": "text",
    "data": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "schedule": {
      "startTime": 1,
      "endTime": 1
    },
    "remoteViewers": {
      "enabled": true,
      "stateUpdateRefreshSeconds": 1
    },
    "ubitusEvent": {
      "specId": "text",
      "minCapacity": 1,
      "maxCapacity": 1
    },
    "videoStream": {
      "youtubeUrl": "text",
      "activeService": "MILLICAST",
      "millicast": {
        "accountId": "text",
        "streamName": "text"
      }
    },
    "projectId": "text",
    "canUserWrite": true
  }
]

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

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.

get

/{eventId}//

Authorizations

Path parameters

eventIdstringrequired

The ID of the event to retrieve

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/events/{eventId}/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text'

200

4XX

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

The response for GET /event/:eventId endpoint

Update an event

patch

/{eventId}//

Authorizations

Path parameters

eventIdstringrequired

The ID of the event to update

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Body

titlestring

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.

worldIdany of

descriptionany of

dataany of

ubitusEventobject

scheduleany of

remoteViewersany of

videoStreamany of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://your-organization-id.m2worlds.io/api/events/{eventId}/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text' \
  --header 'Content-Type: application/json' \
  --data '{"data":{"ANY_ADDITIONAL_PROPERTY":"anything"},"ubitusEvent":{"specId":"text","minCapacity":1,"maxCapacity":1},"schedule":{"startTime":1},"remoteViewers":{"enabled":true},"videoStream":{"activeService":"MILLICAST","millicast":{"accountId":"text","streamName":"text"}}}'

204

4XX

No body

Default Response

Delete an event

delete

/{eventId}//

Authorizations

Path parameters

eventIdstringrequired

The ID of the event to delete

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://your-organization-id.m2worlds.io/api/events/{eventId}/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text'

204

4XX

No body

Default Response

Updates the thumbnail for an event

patch

/{eventId}/pictureUrl/

Authorizations

Path parameters

eventIdstringrequired

The ID of the event to update

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://your-organization-id.m2worlds.io/api/events/{eventId}/pictureUrl/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text'

200

503

4XX

{
  "pictureUrl": "text"
}

The picture url of an event

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.

get

/{eventId}/launchContext/

Authorizations

Path parameters

eventIdstringrequired

ID of the target event for launch context retrieval

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/events/{eventId}/launchContext/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text'

200

4XX

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

The response when retrieving a launch context linked to an event