Skip to main content

WorkAdventure APIs

Choosing the right API for your project​

WorkAdventure comes with 4 APIs:

  • The Room API
  • The Inbound API
  • The Map Storage API
  • The Scripting API

Before trying to integrate your application with WorkAdventure, it is important to understand the scope of each API.

Room API​

The Room API is a gRPC-based API that allows an external server to connect to a room and to perform actions such as reading/modifying/listening to a room variable.

View the Room API documentation

Inbound API​

The inbound API a classic REST API. From your server, you can connect to WorkAdventure to create / edit / delete members in your world. There is also an existing Zapier plugin that is using the inbound API under the hood.

Sample use case: The inbound API is perfect if you want to integrate WorkAdventure with a ticketing system (for instance to create a new member with each ticket sold in your ticketing system).

View the inbound API documentation

Map Storage API​

The map storage API is a REST API that allows you to create and update maps stored in the WorkAdventure server.

Sample use case: The inbound API is perfect if you want to dynamically create maps for your users. Say you have a web application that allows users to create "spaces". Using the map storage API, you can create a new map for each space created by your users.

View the map-storage API documentation

Scripting API​

The scripting API is a client-side API. It is executed in the browser only and can be used to add dynamic behaviours on your maps.

View the scripting API documentation