Matrix

Communication Homeserver URL and access token Windmill docs

Send messages and manage rooms on a Matrix homeserver from any Windmill script, flow or app.

Set up in 2 steps

1

Copy an access token

In your Matrix client, open Settings, then Help & About or Security & Privacy, and reveal the access token. It acts as the signed-in user.

2

Add the resource in Windmill

Open Resources, add a resource of type matrix, and fill baseUrl with your homeserver — https://matrix.example.com — and token.

Scripts

Building blocks, if none of the projects above fit. Fork one, run it, or call it as a step inside your own flow.

Resource type

matrix — the shape of the credential every script on this page expects.

View raw schema →
FieldTypeRequiredWhat it is
baseUrlstringYesThe URL of a Matrix server, like "https://matrix.example.com"
tokenstringNoAn access token to act as a logged-in user. Leave this empty, if you want to perform unauthenticated requests.

Questions

Should I use my own account?

Better not. The token acts as that user, so messages carry their name. Register a dedicated account and invite it to the rooms it needs.

Is my token stored on the hub?

Never. It lives only in your own Windmill workspace, encrypted at rest.