The inbound API is an HTTP REST API that developers can use to access / modify data stored in the WorkAdventure server.
Currently, only "members" of your world can be edited with the Inbound API
A Zapier plugin is available if you want to use this API in a "no-code" approach.
graph BT B --> C[("Database<br/><em>(members)</em>")] A[Your application] -->|Inbound API| B(WorkAdventure server) E[Zapier] -->|Inbound API| B F[Your other application] --> E
In order to connect to the inbound API, you will need an authentication token and a premium access to the world.
You can issue a new authentication token in the administration dashboard of WorkAdventure.
- Go to Settings > Developers
- In the "Tokens" sections, click on "Create new token".
- Give your token a name
- Save the token for the next step.
Connecting to the REST API
The API entrypoint is:
https://workadventu.re/api/v1/worlds/[your world slug]
The "world slug" is the last part of the World URL.
On the "edit your world" popup, you can see the "WorkAdventure URL" of your World.
If the "WorkAdventure URL" of your World is
https://play.workadventu.re/@/foo/bar, then your "world slug"
In order to authenticate with the API, you will need to put the HTTP
Authorization header with every request
you make to the API.
Authentication header MUST be set to the authentication token that you previously generated
All the available entry points are exposed in the OpenAPI spec accessible below: