Skip to content

Technical message format

Technical messages contain application/json data sent through the AMQP application data. They are described by json schema files for validation. The headers, properties and application properties of technical messages are specified in the general AMQP Headers part of this documentation.

Subscription Change Message

A message to notify about a changing subscription status.

Field Type Description
technical_message_type string This is a subscription status message to notify about a change in subscription status. Must be subscription-change.
reference string The related reference (e.g., queue or exchange name) to which the message has been sent.
event string The event which triggered the subscription change. Must be one of create, delete, maintenance-start, maintenance-stop, resume, user-request.
new_status string The status of the subscription after this message has been sent. Must be one of active, paused, absent.
reason string | null Business reason of the subscription status change.
requester string The requester of this subscription change. Must be one of USER, DWD.
JSON schema
subscription_change_message.json
{
    "examples": [
        {
            "event": "create",
            "new_status": "paused",
            "reference": "my_queue",
            "requester": "DWD",
            "type": "Subscription-Status"
        }
    ],
    "properties": {
        "technical_message_type": {
            "const": "subscription-change",
            "default": "subscription-change",
            "description": "This is a subscription status message to notify about a change in subscription status.",
            "title": "Technical Message Type",
            "type": "string"
        },
        "reference": {
            "description": "The related reference (e.g., queue or exchange name) to which the message has been sent.",
            "title": "Reference",
            "type": "string"
        },
        "event": {
            "description": "The event which triggered the subscription change.",
            "enum": [
                "create",
                "delete",
                "maintenance-start",
                "maintenance-stop",
                "resume",
                "user-request"
            ],
            "title": "Event",
            "type": "string"
        },
        "new_status": {
            "description": "The status of the subscription after this message has been sent.",
            "enum": [
                "active",
                "paused",
                "absent"
            ],
            "title": "New Status",
            "type": "string"
        },
        "reason": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "default": null,
            "description": "Business reason of the subscription status change.",
            "title": "Reason"
        },
        "requester": {
            "description": "The requester of this subscription change.",
            "enum": [
                "USER",
                "DWD"
            ],
            "title": "Requester",
            "type": "string"
        }
    },
    "required": [
        "reference",
        "event",
        "new_status",
        "requester"
    ],
    "title": "SubscriptionChangeMessage",
    "type": "object"
}

Scheduled Maintenance Message

A message which notifies about a scheduled maintenance in the future.

Field Type Description
technical_message_type string This is a scheduled maintenance message to notify about a scheduled maintenance. Must be scheduled-maintenance.
reference string The related reference (e.g., queue or exchange name) to which the message has been sent.
planned_status string The status of the subscription during the maintenance period. Must be one of active, paused, absent.
start string The start datetime in ISO8601 format of the maintenance. If no timezone information is provided the datetime is in UTC.
duration string The duration in ISO8601 format of the maintenance.
JSON schema
scheduled_maintenance_message.json
{
    "properties": {
        "technical_message_type": {
            "const": "scheduled-maintenance",
            "default": "scheduled-maintenance",
            "description": "This is a scheduled maintenance message to notify about a scheduled maintenance.",
            "title": "Technical Message Type",
            "type": "string"
        },
        "reference": {
            "description": "The related reference (e.g., queue or exchange name) to which the message has been sent.",
            "title": "Reference",
            "type": "string"
        },
        "planned_status": {
            "description": "The status of the subscription during the maintenance period.",
            "enum": [
                "active",
                "paused",
                "absent"
            ],
            "title": "Planned Status",
            "type": "string"
        },
        "start": {
            "description": "The start datetime in ISO8601 format of the maintenance. If no timezone information is provided the datetime is in UTC.",
            "example": "2025-01-01T12:00:00Z",
            "format": "date-time",
            "title": "Start",
            "type": "string"
        },
        "duration": {
            "description": "The duration in ISO8601 format of the maintenance.",
            "example": "P3D",
            "format": "duration",
            "title": "Duration",
            "type": "string"
        }
    },
    "required": [
        "reference",
        "planned_status",
        "start",
        "duration"
    ],
    "title": "ScheduledMaintenanceMessage",
    "type": "object"
}

Data Error Message

A message which notifies about a current error in the queue.

Field Type Description
technical_message_type string This is a data error message to notify the consumer that something went wrong during data processing. Must be data-error.
error_type string This is the machine readable type of the error. If the type is 'unknown' an unknown error occurred and additional details can be found in 'error_message'. Must be one of validation-error, processing-error, system-delay, missing-data, message-expired, unknown.
error_message string | null This is a human-readable error message with details about the error.
JSON schema
data_error_message.json
{
    "properties": {
        "technical_message_type": {
            "const": "data-error",
            "default": "data-error",
            "description": "This is a data error message to notify the consumer that something went wrong during data processing.",
            "title": "Technical Message Type",
            "type": "string"
        },
        "error_type": {
            "description": "This is the machine readable type of the error. If the type is 'unknown' an unknown error occurred and additional details can be found in 'error_message'.",
            "enum": [
                "validation-error",
                "processing-error",
                "system-delay",
                "missing-data",
                "message-expired",
                "unknown"
            ],
            "title": "Error Type",
            "type": "string"
        },
        "error_message": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "default": null,
            "description": "This is a human-readable error message with details about the error.",
            "title": "Error Message"
        }
    },
    "required": [
        "error_type"
    ],
    "title": "DataErrorMessage",
    "type": "object"
}

Expired Message

A message to notify about expired messages in the queue

Field Type Description
technical_message_type string This is a data error message to notify the consumer that something went wrong during data processing. Must be data-error.
error_type string This error notifies about a message which expired in this subscription. Must be message-expired.
error_message string | null This is a human-readable error message with details about the error.
original_subject string The original message subject of the expired message.
original_reference string The original queue/exchange/topic in which the message expired.
original_message_id string The id of the expired message.
expiration_time string The original timestamp of the expired message.
JSON schema
expired_message.json
{
    "properties": {
        "technical_message_type": {
            "const": "data-error",
            "default": "data-error",
            "description": "This is a data error message to notify the consumer that something went wrong during data processing.",
            "title": "Technical Message Type",
            "type": "string"
        },
        "error_type": {
            "const": "message-expired",
            "default": "message-expired",
            "description": "This error notifies about a message which expired in this subscription.",
            "title": "Error Type",
            "type": "string"
        },
        "error_message": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "default": null,
            "description": "This is a human-readable error message with details about the error.",
            "title": "Error Message"
        },
        "original_subject": {
            "description": "The original message subject of the expired message.",
            "title": "Original Subject",
            "type": "string"
        },
        "original_reference": {
            "description": "The original queue/exchange/topic in which the message expired.",
            "title": "Original Reference",
            "type": "string"
        },
        "original_message_id": {
            "description": "The id of the expired message.",
            "title": "Original Message Id",
            "type": "string"
        },
        "expiration_time": {
            "description": "The original timestamp of the expired message.",
            "format": "date-time",
            "title": "Expiration Time",
            "type": "string"
        }
    },
    "required": [
        "original_subject",
        "original_reference",
        "original_message_id",
        "expiration_time"
    ],
    "title": "ExpiredMessage",
    "type": "object"
}

Heartbeat Messages

The heartbeat message shall be settled by the consumer.

Field Type Description
technical_message_type string This is a heartbeat message to notify the consumer that the connection is established. Must be heartbeat.
timestamp string Time in ISO8601 format at which this heartbeat was sent.
JSON schema
heartbeat_message.json
{
    "properties": {
        "technical_message_type": {
            "const": "heartbeat",
            "default": "heartbeat",
            "description": "This is a heartbeat message to notify the consumer that the connection is established.",
            "title": "Technical Message Type",
            "type": "string"
        },
        "timestamp": {
            "description": "Time in ISO8601 format at which this heartbeat was sent.",
            "example": "2025-01-01T12:00:00Z",
            "format": "date-time",
            "title": "Timestamp",
            "type": "string"
        }
    },
    "required": [
        "timestamp"
    ],
    "title": "HeartbeatMessage",
    "type": "object"
}