Skip to main content

Matrix

In order for this badge to work, the host of your room must allow guest accounts or dummy accounts to register, and the room must be world readable (chat history visible to anyone).

Alternatively access via the experimental summary endpoint (MSC3266) can be configured with the query parameter fetchMode for less server load and better performance, if supported by the homeserver
For the matrix.org homeserver fetchMode is hard-coded to summary.

The following steps will show you how to setup the badge URL using the Element Matrix client.

  • Select the desired room inside the Element client
  • Click on the room settings button (gear icon) located near the top right of the client
  • Scroll to the very bottom of the settings page and look under the Addresses section
  • You should see one or more room addresses (or aliases), which can be easily identified with their starting hash (#) character (ex: #twim:matrix.org)
  • If there is no address for this room, add one under Local addresses for this room
  • Remove the starting hash character (#)
  • The final badge URL should look something like this /matrix/twim:matrix.org.svg

Some Matrix homeservers don't hold a server name matching where they live (e.g. if the homeserver example.com that created the room alias #mysuperroom:example.com lives at matrix.example.com).

If that is the case of the homeserver that created the room alias used for generating the badge, you will need to add the server's FQDN (fully qualified domain name) as a query parameter.

The final badge URL should then look something like this /matrix/mysuperroom:example.com.svg?server_fqdn=matrix.example.com.

Path Parameters
roomAlias string — REQUIRED

Example: twim:matrix.org

Query Parameters
server_fqdn string

Example: matrix.org

fetchMode string

Possible values: [guest, summary]

guest configures guest authentication while summary configures usage of the experimental "summary" endpoint (MSC3266). If not specified, the default fetch mode is guest (except for matrix.org).

Example: guest

style string

Possible values: [flat, flat-square, plastic, for-the-badge, social]

If not specified, the default style for this badge is "flat".

Example: flat

logo string

Icon slug from simple-icons. You can click the icon title on simple-icons to copy the slug or they can be found in the slugs.md file in the simple-icons repository. Further info.

Example: appveyor

logoColor string

The color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported). Supported for simple-icons logos but not for custom logos.

Example: violet

logoSize string

Make icons adaptively resize by setting auto. Useful for some wider logos like amd and amg. Supported for simple-icons logos but not for custom logos.

Example: auto

label string

Override the default left-hand-side text (URL-Encoding needed for spaces or special characters!)

Example: healthiness

labelColor string

Background color of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported).

Example: abcdef

color string

Background color of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported).

Example: fedcba

cacheSeconds string

HTTP cache lifetime (rules are applied to infer a default value on a per-badge basis, any values specified below the default will be ignored).

Example: 3600

link string[]

Specify what clicking on the left/right of a badge should do. Note that this only works when integrating your badge in an <object> HTML tag, but not an <img> tag or a markup language.