LogoLogo
API Status
  • 👋Welcome
  • 🌐What is Morpheus Platform?
    • Interoperability
  • â„šī¸Help
    • 📗Glossary
    • 🆘Support
    • Firewall problems
    • EULA
  • CREATION
    • 🎮Unreal Development
      • ⚡Get Started
        • âš’ī¸Download the Editor
        • âĢUpload Content
        • 🌎Creating your own map
        • 📝Morpheus Base Project
        • ❓Differences from Unreal
          • 🧍Character Configuration
        • 📡Morpheus Networking
          • Introduction to Morpheus Networking
          • Network Levels
          • Replicated Properties
          • RPCs
          • Morpheus Render Targets
          • Morpheus Array
          • Networking FAQ
          • Replicating Sublevels
      • 📚Features & Guides
        • 📒Example Plugin
          • Nameplates
          • In-game roles
        • 🏊Actor Pooling
        • 🔊Audio
        • 🎭Avatars
          • Creating an Avatar
          • Attachments
            • MML Attachments
          • Custom Animation Variables
          • Importing an NFT collection
          • Capsules and Mesh Transforms
        • 🤖Bots
        • đŸŽ™ī¸Chat
          • Unreal Text Chat
        • đŸŽ›ī¸Control Panels
          • Control Panel Configuration
          • DJ booth mission control
          • Observer Controls
        • 🔉Crowd Audio
        • đŸ¤ŧCrowd Rendering
          • Legacy Animated Crowd
            • Animated Crowd Console Commands
            • Attaching static meshes to crowd members
          • Crowd Materials
          • Performance Parameters
          • Live Config Settings
          • Crowd Animation
            • Crowd Anim Blueprint
              • User Guide - Crowd Anim Blueprint
              • Reference Guide - ABP Nodes
                • Animation Playback
                • States and State Machines
                • Variables
                • Transitions
                • Special
                • Blends
                • Additional Notes
        • 🍱Helpers & Extras
          • "Instanced Objects" in Blueprints
          • Objects with "world context"
          • Making DataAsset classes
          • Duplicate Objects
          • The Bootflow Subsystem
          • The "Wait For Condition" System
          • Advanced Graphics settings
          • Listening to inputs on UObjects
          • Morpheus UserID
          • World Services
          • M2Extras: Skins System
        • đŸ–Ĩī¸Loading Screen
        • ⚡Live Config
          • Editing for a World
          • Editing Locally
          • Default Settings
          • Accessing via Blueprint
          • Adding New Settings
          • Overriding Defaults
          • Using Arrays
        • 🧊MML
        • đŸ•ēMotion Capture
        • 📡Networking
        • đŸ“ĸNotifications
        • Raycastable Crowd
        • 🌐Singletons
        • 📱Streaming & Multiplatform
          • GFN on mobile
        • đŸ–Ĩī¸UI
          • "UI Mode"
        • đŸ—ƒī¸User Collections
          • Creating a New Object Definition
          • Accessing from Unreal
            • Creating Objects Definitions
            • Transfer Objects
            • User Collection Views
            • Receiving Updates
        • đŸ“ēVideo Players
          • Embedded Video Player
          • Millicast video streaming
            • How to Setup an In-Game Video Stream
            • Picture-in-Picture mode
          • Streaming Video Player
            • How to Setup a URL Video Player
            • Picture-in-Picture mode
        • 🐞Visual Debugging
          • Inspector
        • đŸĒŸWeb UI
        • 💠Web Requests
          • Http Requests
            • Legacy HTTP Nodes
          • JSON Handling
          • WebSockets
          • Identity Validation
          • Allowed External URLs
          • Walkthrough Example
            • Example Counter Service
        • âœˆī¸World Travel
          • World Travel in the editor
        • Avatar Physics Assets
        • Action Gameplay Helper Components
      • 🔑Workflows
        • â†—ī¸Upgrade the Editor
          • đŸ–Ĩī¸Version History
        • âš™ī¸Editing Project Settings
        • 📈Profiling
        • đŸ§ēMarketplace Importing
        • đŸ› ī¸Extra Workflows
          • Setup Play-in-Editor
          • Setup Local Asset Validation
          • Adding Gameplay Tags
          • Validating Game Assets
          • Custom Connection Modes
          • Connect Editor to a World
          • Common Issues
      • 📚Useful Reading
        • ⭐Best Practices
    • 🌎Worlds
      • 📩Invite Players
        • Setting Role Groups
      • Persistent Worlds
      • Always on Worlds
    • 📅Running events
      • ✅Large scale events - Checklist
      • 👾Anti-Cheat (EAC)
      • 🎮Player Entry
        • 📱React Native
        • Steam
        • đŸ’ģHardware Reqs
      • đŸŽĨBroadcast
        • 📹OBS Integration
      • Failover
      • 🏁Capacity And Queue Management
  • ADMINS
    • đŸ‘ĒAccess Control
      • Adding metaverse contributors
      • Creating a new project
    • 💲Pricing
      • Development Support
      • Included Usage & Overages
      • Cloud Streaming
      • Access Modes
      • War Room Support
      • Platform SLA
    • âš™ī¸Settings
      • đŸ—ƒī¸Projects
  • APIs and Tooling
    • 👩‍đŸ’ģIntroduction
    • đŸ–Ĩī¸API Reference
      • Accounts
      • Datasources
      • Events
      • Key/Value Store
      • Organizations
      • Realtime
      • Sessions
      • User Profile
      • World Builder
      • Worlds
    • đŸ“ĻFrontend SDKs
      • 📄Version History
      • Pixel Streaming
    • 🚀Launcher
  • Integrations
    • 📊Analytics
      • Sending events from web
      • 🎮Sending Events from Unreal
    • đŸ’ŦChat
      • 🎮Integrating Pubnub with your Unreal Project
      • Adding Moderation to Chat
Powered by GitBook
On this page

Was this helpful?

  1. APIs and Tooling
  2. API Reference

Events

Manages events

PreviousDatasourcesNextKey/Value Store

Last updated 8 days ago

Was this helpful?

đŸ–Ĩī¸

Get all publicly visible events

get

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

Header parameters
x-m2-organization-idstringRequired

The ID of an organization

x-m2-project-idstringRequired

The ID of a project

Responses
200
The response for GET /events/public, an array of public events
application/json
4XX
The error object returned by the API when an error occurs
application/json
get
GET /api/events/public/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-m2-organization-id: text
x-m2-project-id: text
Accept: */*
[
  {
    "title": "text",
    "eventId": "text",
    "worldId": "text",
    "schedule": {
      "startTime": 1,
      "endTime": 1
    },
    "videoStream": {
      "millicast": {
        "accountId": "text",
        "streamName": "text"
      },
      "youtubeUrl": "text",
      "activeService": "MILLICAST"
    },
    "pictureUrl": "text",
    "isPublic": true,
    "description": "text",
    "data": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "ubitusEvent": {
      "specId": "text",
      "minCapacity": 1,
      "maxCapacity": 1
    },
    "projectId": "text",
    "canUserWrite": true
  }
]

Get an event

get

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.

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
200
The response for GET /event/:eventId endpoint
application/json
Responseall of

The response for GET /event/:eventId endpoint

4XX
The error object returned by the API when an error occurs
application/json
get
GET /api/events/{eventId}/ HTTP/1.1
Host: your-organization-id.m2worlds.io
Authorization: Bearer YOUR_SECRET_TOKEN
x-m2-organization-id: text
x-m2-project-id: text
Accept: */*
{
  "title": "text",
  "eventId": "text",
  "worldId": "text",
  "schedule": {
    "startTime": 1,
    "endTime": 1
  },
  "videoStream": {
    "millicast": {
      "accountId": "text",
      "streamName": "text"
    },
    "youtubeUrl": "text",
    "activeService": "MILLICAST"
  },
  "pictureUrl": "text",
  "isPublic": true,
  "description": "text",
  "data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ubitusEvent": {
    "specId": "text",
    "minCapacity": 1,
    "maxCapacity": 1
  },
  "launchContext": {
    "launchContextId": "text",
    "errorPageUrl": "text",
    "okPageUrl": "text",
    "gdnStreaming": {
      "cmsId": "text",
      "authorizationId": "text",
      "launchMode": "same-tab",
      "useCustomClient": true,
      "useWindowedMode": true
    },
    "ubitusStreaming": {
      "gameLabel": "text",
      "gameChannel": "text"
    },
    "streamManager": {
      "streamContextId": "text",
      "allowForceProvider": true,
      "showProviderOptions": true,
      "useBuildVersion": true
    },
    "enableQueue": true,
    "capacity": 1,
    "isActive": true,
    "buildInfo": {
      "buildChannelId": "text",
      "buildTag": "text",
      "buildType": "client"
    },
    "publicDownload": {
      "enabled": true,
      "enforceAntiCheat": true,
      "allowMac": true,
      "allowIos": true
    },
    "bypassBrowserRestrictions": true,
    "isPublic": true,
    "projectId": "text",
    "organizationId": "text",
    "worldId": "text"
  },
  "canUserWrite": true,
  "projectId": "text"
}

Delete an event

delete
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
204
Default Response
application/json
Responseany
4XX
The error object returned by the API when an error occurs
application/json
delete
DELETE /api/events/{eventId}/ HTTP/1.1
Host: your-organization-id.m2worlds.io
Authorization: Bearer YOUR_SECRET_TOKEN
x-m2-organization-id: text
x-m2-project-id: text
Accept: */*

No content

Updates the thumbnail for an event

patch
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
200
The picture url of an event
application/json
503
The error object returned by the API when an error occurs
application/json
4XX
The error object returned by the API when an error occurs
application/json
patch
PATCH /api/events/{eventId}/pictureUrl/ HTTP/1.1
Host: your-organization-id.m2worlds.io
Authorization: Bearer YOUR_SECRET_TOKEN
x-m2-organization-id: text
x-m2-project-id: text
Accept: */*
{
  "pictureUrl": "text"
}

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

get

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.

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
200
The response when retrieving a launch context linked to an event
application/json
Responseall of

The response when retrieving a launch context linked to an event

4XX
The error object returned by the API when an error occurs
application/json
get
GET /api/events/{eventId}/launchContext/ HTTP/1.1
Host: your-organization-id.m2worlds.io
Authorization: Bearer YOUR_SECRET_TOKEN
x-m2-organization-id: text
x-m2-project-id: text
Accept: */*
{
  "launchContextId": "text",
  "errorPageUrl": "text",
  "okPageUrl": "text",
  "gdnStreaming": {
    "cmsId": "text",
    "authorizationId": "text",
    "launchMode": "same-tab",
    "useCustomClient": true,
    "useWindowedMode": true
  },
  "ubitusStreaming": {
    "gameLabel": "text",
    "gameChannel": "text"
  },
  "streamManager": {
    "streamContextId": "text",
    "allowForceProvider": true,
    "showProviderOptions": true,
    "useBuildVersion": true
  },
  "enableQueue": true,
  "capacity": 1,
  "isActive": true,
  "buildInfo": {
    "buildChannelId": "text",
    "buildTag": "text",
    "buildType": "client"
  },
  "publicDownload": {
    "enabled": true,
    "enforceAntiCheat": true,
    "allowMac": true,
    "allowIos": true
  },
  "bypassBrowserRestrictions": true,
  "isPublic": true,
  "projectId": "text",
  "organizationId": "text",
  "worldId": "text"
}
  • GETGet all events
  • POSTCreate an event
  • GETGet all publicly visible events
  • GETGet an event
  • PATCHUpdate an event
  • DELETEDelete an event
  • PATCHUpdates the thumbnail for an event
  • GETGet the data needed to launch into the world linked to an event

Get all events

get

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.

Authorizations
Header parameters
x-m2-organization-idstringRequired

The ID of an organization

x-m2-project-idstringOptional

The ID of a project

Responses
200
The response for GET /events, an array of all events a user has permission to access
application/json
Responseall of[]

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

4XX
The error object returned by the API when an error occurs
application/json
get
GET /api/events/ HTTP/1.1
Host: your-organization-id.m2worlds.io
Authorization: Bearer YOUR_SECRET_TOKEN
x-m2-organization-id: text
Accept: */*
[
  {
    "title": "text",
    "eventId": "text",
    "worldId": "text",
    "schedule": {
      "startTime": 1,
      "endTime": 1
    },
    "videoStream": {
      "millicast": {
        "accountId": "text",
        "streamName": "text"
      },
      "youtubeUrl": "text",
      "activeService": "MILLICAST"
    },
    "pictureUrl": "text",
    "isPublic": true,
    "description": "text",
    "data": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "ubitusEvent": {
      "specId": "text",
      "minCapacity": 1,
      "maxCapacity": 1
    },
    "launchContext": {
      "launchContextId": "text",
      "errorPageUrl": "text",
      "okPageUrl": "text",
      "gdnStreaming": {
        "cmsId": "text",
        "authorizationId": "text",
        "launchMode": "same-tab",
        "useCustomClient": true,
        "useWindowedMode": true
      },
      "ubitusStreaming": {
        "gameLabel": "text",
        "gameChannel": "text"
      },
      "streamManager": {
        "streamContextId": "text",
        "allowForceProvider": true,
        "showProviderOptions": true,
        "useBuildVersion": true
      },
      "enableQueue": true,
      "capacity": 1,
      "isActive": true,
      "buildInfo": {
        "buildChannelId": "text",
        "buildTag": "text",
        "buildType": "client"
      },
      "publicDownload": {
        "enabled": true,
        "enforceAntiCheat": true,
        "allowMac": true,
        "allowIos": true
      },
      "bypassBrowserRestrictions": true,
      "isPublic": true,
      "projectId": "text",
      "organizationId": "text",
      "worldId": "text"
    },
    "canUserWrite": true,
    "projectId": "text"
  }
]

Create an event

post

Creates an event in the project specified in the headers

Authorizations
Header parameters
x-m2-organization-idstringRequired

The ID of an organization

x-m2-project-idstringRequired

The ID of a project

Body

Body of POST /events to create an event

titlestringRequired
worldIdstringOptional

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

pictureUrlstringOptional

The URL of the thumbnail for the event

isPublicbooleanOptional

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.

descriptionstringOptional
Responses
201
The response for POST /events, an eventId representing the created event
application/json
4XX
The error object returned by the API when an error occurs
application/json
post
POST /api/events/ HTTP/1.1
Host: your-organization-id.m2worlds.io
Authorization: Bearer YOUR_SECRET_TOKEN
x-m2-organization-id: text
x-m2-project-id: text
Content-Type: application/json
Accept: */*
Content-Length: 356

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

Update an event

patch
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

Body of PATCH /events to update an event

titlestringOptional
worldIdany ofOptional
stringOptional

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

or
nullOptional
scheduleany ofOptional
or
nullOptional
videoStreamany ofOptional
or
nullOptional
pictureUrlstringOptional

The URL of the thumbnail for the event

isPublicbooleanOptional

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 ofOptional
stringOptional
or
nullOptional
dataany ofOptional
or
nullOptional
Responses
204
Default Response
application/json
Responseany
4XX
The error object returned by the API when an error occurs
application/json
patch
PATCH /api/events/{eventId}/ HTTP/1.1
Host: your-organization-id.m2worlds.io
Authorization: Bearer YOUR_SECRET_TOKEN
x-m2-organization-id: text
x-m2-project-id: text
Content-Type: application/json
Accept: */*
Content-Length: 356

{
  "title": "text",
  "worldId": "text",
  "schedule": {
    "startTime": 1,
    "endTime": 1
  },
  "videoStream": {
    "millicast": {
      "accountId": "text",
      "streamName": "text"
    },
    "youtubeUrl": "text",
    "activeService": "MILLICAST"
  },
  "pictureUrl": "text",
  "isPublic": true,
  "description": "text",
  "data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ubitusEvent": {
    "specId": "text",
    "minCapacity": 1,
    "maxCapacity": 1
  }
}

No content