Package Information
Available Nodes
Documentation generating…
Documentation
n8n-nodes-workadventure
This is an n8n community node package. It lets you use WorkAdventure in your n8n workflows.
WorkAdventure is a virtual office and collaboration platform for remote and hybrid teams. This package manages the
members of your world through the Inbound API and starts
workflows from WorkAdventure webhooks.
n8n is a fair-code licensed workflow automation platform.
Installation
Follow the installation guide in the n8n community
nodes documentation and install n8n-nodes-workadventure.
Credentials
The Inbound API and webhooks need a premium world: requests for other worlds are refused (403).
- In the WorkAdventure admin, open your world and go to Developers > API keys / Zapier.
- Create an API token and copy it, along with the world slug shown on that page.
- In n8n, create a WorkAdventure API credential:
- Admin URL: keep
https://admin.workadventu.reunless your WorkAdventure is self-hosted. - World Slug: the slug of your world (the last part of its URL:
barinhttps://play.workadventu.re/@/foo/bar). - API Token: the token you created.
- Admin URL: keep
n8n checks the credential with GET /api/v1/worlds/{worldSlug}.
Operations
All operations work on the Member resource.
| Operation | What it does |
|---|---|
| Create or Update | Creates a member. If a member with this email already exists, it is overwritten: fields left empty are cleared and tags are replaced. Use Update to change only some fields. |
| Update | Updates a member, found by UUID or email. Fields left empty are not changed. |
| Delete | Deletes a member (or visitor). |
| Get | Gets a member (or visitor) by UUID or email. |
| Get Many | Lists members, visitors, or both. Turn on Return All to page through all of them, or set a Limit (100 at most). |
Notes:
- Tags are comma-separated, e.g.
admin, speaker. They decide what the member can access (see
the documentation) and replace the existing tags of the member.
With Update, entermemberto remove all tags. - Access Token is the secret used in the member's private access links. It must be unique. On Create or Update,
leave it empty and a new member gets a generated one while an existing member keeps theirs. Changing it invalidates
the member's current links. - Visitors (self-registered accounts) can be read and deleted, not created or updated. The
typefield of a member
(memberorvisitor) tells them apart.
Trigger
WorkAdventure Trigger starts a workflow when events happen in your world. Pick the events:
| Event | Delivery type |
Notes |
|---|---|---|
| Recording Completed | recording.completed |
data.downloadUrl is valid for 7 days. |
| Visitor Registered | visitor.registered |
|
| Consent Changed | consent.changed |
|
| Member Connecting | member.connecting |
Synchronous, see below. |
| Analytics (Experimental) | analytics.batch |
High volume, see below. |
Each execution receives one delivery: the WorkAdventure envelope (deliveryId, apiVersion, type, timestamp,world, data). Retries reuse the same deliveryId: deduplicate on it if a duplicate would hurt. The
webhook documentation describes every payload.
Registration
You do not need to configure anything in the WorkAdventure admin. When you activate the workflow, or click
Listen for test event, the node registers its URL in WorkAdventure through the API, and removes it when the workflow
is deactivated or the test ends. The endpoint shows up in Developers > Webhook settings while it exists. If
WorkAdventure disabled the endpoint (after repeated failed deliveries, for instance while n8n was down), re-enable it
on its page in the admin, or deactivate and reactivate the workflow. Restarting n8n is not enough: n8n keeps the
registrations of active workflows across restarts without asking WorkAdventure again.
WorkAdventure only delivers to public HTTPS URLs: your n8n instance must be reachable from the internet over HTTPS.
Signature check
Every delivery is signed (Standard Webhooks) with a secret WorkAdventure returns
when the node registers its URL. The node checks the signature over the raw request body and refuses deliveries whose
timestamp is more than 5 minutes off. Anything that fails the check is answered 401 and does not start the
workflow.
Test deliveries
The Test button on the endpoint page in the WorkAdventure admin sends a sample marked "test": true. The node lets
these through while you Listen for test event in the editor, and ignores them (answering 200, without starting an
execution) in an active workflow.
Member Connecting (auth)
This event is sent synchronously while a member logs in: WorkAdventure waits up to 5 seconds for the answer
before granting access, and never blocks access when the call fails or times out. Set Respond to
When Last Node Finishes to update the member (their tags, typically) with the WorkAdventure node before access
is granted. Keep that workflow short.
The payload carries data.accessTokens: the OAuth access tokens of the member, for the OpenID Connect providers you
set to expose them. Treat them as secrets, and do not keep execution data you do not need (see the workflow's
Save successful production executions setting).
Analytics (analytics)
Experimental: event names and properties may change without notice. A busy world sends a lot of events (one
video-quality sample every 5 seconds per user in a meeting), batched up to 100 per delivery in data.events.
Expect many executions.
Compatibility
Built and tested with n8n 2.42 (n8n-workflow 2.42) and @n8n/node-cli 0.51.