Skip to content
HALOWERK

Datenwerk

matrix notify

Uses the Matrix Client-Server API v3: resolves a room alias (#room:server) via the room directory, then sends an m.room.message (m.text or m.notice, optional HTML formatted_body built from your Markdown-light text) with a unique transaction ID to your homeserver. The access token goes only to your homeserver and is never stored or echoed. Returns event ID or the Matrix errcode. With dry_run the event is built and the alias resolved without sending.

POST https://daten.halowerk.com/v1/matrix-notify

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
homeserverstringYes
roomstringYes
messagestringYes
noticebooleanNo
access_tokenstringNo
dry_runbooleanNo
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "homeserver",
    "room",
    "message"
  ],
  "properties": {
    "homeserver": {
      "type": "string",
      "format": "uri",
      "maxLength": 300
    },
    "room": {
      "type": "string",
      "pattern": "^[!#][^\\s:]+:[A-Za-z0-9.-]+(:\\d+)?$"
    },
    "message": {
      "type": "string",
      "minLength": 1,
      "maxLength": 8000
    },
    "notice": {
      "type": "boolean",
      "default": false
    },
    "access_token": {
      "type": "string",
      "minLength": 10,
      "maxLength": 500
    },
    "dry_run": {
      "type": "boolean",
      "default": false
    }
  }
}

Open original schema

Published input example

{
  "homeserver": "https://matrix.org",
  "room": "#matrix:matrix.org",
  "message": "Deploy **finished**",
  "dry_run": true
}

Result & documentation

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-17 UTC.

More endpoints in this hub

All endpoints in this hub โ†’