AMQP · Schema

AMQP Message

Schema describing the structure of an AMQP 0-9-1 message including properties, headers, and payload. An AMQP message consists of message properties (metadata), application headers, and a binary payload body.

AMQPAsynchronousMessage QueueMessagingMiddlewareOpen StandardPublish Subscribe

Properties

Name	Type	Description
properties	object
headers	object	Application-specific headers as key-value pairs sent in the message header frame.
body	object	The message body content. Can be any valid JSON value or a binary payload represented as a base64-encoded string.
exchange	string	The exchange the message was published to.
routingKey	string	The routing key used when publishing the message.
mandatory	boolean	If true, the server will return an undeliverable message with a Return method. If false, the server silently drops the message.
immediate	boolean	If true, the server will return an undeliverable message if it cannot be immediately consumed. Deprecated in AMQP 0-9-1.

View JSON Schema on GitHub

JSON Schema

{
  "$id": "amqp-message.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "AMQP Message",
  "description": "Schema describing the structure of an AMQP 0-9-1 message including properties, headers, and payload. An AMQP message consists of message properties (metadata), application headers, and a binary payload body.",
  "type": "object",
  "required": [
    "body"
  ],
  "properties": {
    "properties": {
      "$ref": "amqp-message-properties.json"
    },
    "headers": {
      "type": "object",
      "description": "Application-specific headers as key-value pairs sent in the message header frame.",
      "additionalProperties": true
    },
    "body": {
      "description": "The message body content. Can be any valid JSON value or a binary payload represented as a base64-encoded string.",
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "array"
        },
        {
          "type": "string"
        },
        {
          "type": "number"
        },
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ]
    },
    "exchange": {
      "type": "string",
      "description": "The exchange the message was published to."
    },
    "routingKey": {
      "type": "string",
      "description": "The routing key used when publishing the message."
    },
    "mandatory": {
      "type": "boolean",
      "description": "If true, the server will return an undeliverable message with a Return method. If false, the server silently drops the message.",
      "default": false
    },
    "immediate": {
      "type": "boolean",
      "description": "If true, the server will return an undeliverable message if it cannot be immediately consumed. Deprecated in AMQP 0-9-1.",
      "default": false
    }
  },
  "additionalProperties": false
}