AMQP 1.0

The AMQP 1.0 connection allows the Intelligence Hub to connect to brokers that support the AMQP 1.0 protocol for reading and writing messages.

Connection Settings

SettingDescription
Authentication TypeHow the connection authenticates with the broker. Default is None. See the options below.
HostThe hostname or IP address of the broker.
PortThe port the broker listens on. Default is 5672. Brokers commonly listen for TLS connections on 5671.
Virtual HostThe broker virtual host to connect to. Default is /, the broker’s default virtual host. Enter the name exactly as defined on the broker. A leading / is part of the name, so /myHost and myHost are different virtual hosts.
Container IDIdentifies this connection to the broker, similar to an MQTT client ID. Leave blank to generate an ID.
Connect Timeout (seconds)Maximum time to wait for the connection to the broker to open. Also limits the OAuth 2.0 token request, attaching to an address, and how long a write waits for the broker to accept a message. Valid range is 1–300 seconds, default 10 seconds.
Idle Timeout (seconds)The idle timeout requested from the broker, used to detect a dead connection. Valid range is 0–3600 seconds, default 60 seconds. 0 disables it, so a broker or network failure that does not close the connection can go undetected.
Enable SSLEnable for brokers that require transport layer security. Disabled by default. Required by the OAuth 2.0 and Certificate authentication types. See additional TLS options below.

Authentication Type Options:

OptionDescription
NoneConnect without credentials, using the SASL ANONYMOUS mechanism.
Username / PasswordAuthenticate with a username and password, using the SASL PLAIN mechanism. The Password supports Secrets.
OAuth 2.0Authenticate with an access token requested from an identity provider. Requires Enable SSL. See OAuth 2.0 Authentication below.
CertificateAuthenticate with the client certificate presented during the TLS handshake, using the SASL EXTERNAL mechanism. Select the Client Certificate/Key Pair from the certificate store. Requires Enable SSL.

TLS Options (shown when Enable SSL is enabled):

OptionDescription
Ignore Self-Signed CertificateAccepts any certificate returned from the broker. Use only for testing. Disabled by default.
Server CertificateThe broker’s CA certificate imported into the certificate store. When blank, the broker’s certificate is validated against the default Java trust store, which works for brokers using certificates from a public CA. Shown when Ignore Self-Signed Certificate is disabled.

OAuth 2.0 Authentication

The connection requests an access token with the OAuth 2.0 client credentials grant and presents it to the broker when connecting. The token is reused until shortly before it expires.

SettingDescription
Token URLThe OAuth 2.0 token endpoint the access token is requested from. Must be an http or https URL.
Client IDThe OAuth 2.0 client ID.
Client SecretThe OAuth 2.0 client secret. Supports Secrets.
UsernameThe identity sent to the broker alongside the access token. Required.
SASL MechanismHow the access token is presented to the broker. Default is PLAIN. See the options below.
ScopeOptional scope to request.
AudienceOptional list of audience values to request.
Client AuthenticationWhere the Client ID and Client Secret are sent on the token request: Send as Basic Auth Header (default) or Send client credentials in body.

SASL Mechanism Options

MechanismDescription
PLAINSends the access token as the password.
XOAUTH2Used by brokers such as Solace and Apache Qpid Broker-J.
OAUTHBEARERThe standard OAuth 2.0 SASL mechanism (RFC 7628).

Input Settings

AMQP 1.0 inputs support subscriptions and can be used as a source in an Event Trigger.

SettingDescription
AddressThe broker node to receive messages from. The address syntax, including any wildcard support, is defined by the broker.
Message FormatHow to decode the message payload. Default is Auto. See the options below.
Include MetadataWhen enabled, the address and AMQP metadata of the message are included alongside the value in the read data. Disabled by default. See the example below.
PrefetchMaximum number of messages the broker may send ahead of them being consumed. Valid range is 1–1000, default 10. Inputs that share an address use the value set by the first one to start.

Message Format Options

TypeDescription
AutoThe payload can be JSON, String, or Binary.
JSONThe payload is deserialized as JSON. A payload that is not valid JSON returns a bad value.
StringThe payload is treated as a UTF-8 string.
BinaryThe payload is treated as a byte array.

Reading Messages

Inputs consume the messages they receive, and the Intelligence Hub acknowledges each message as it arrives. Consumed messages are removed from the queue, so an input competes with any other consumer of the same queue.

  • A read, including a test read, returns the last message received on the address. Before the first message arrives, the read returns no value.
  • An Event Trigger subscription receives every message in the order it arrives.

Include Metadata Example

{
	"_address": "/queues/factory.events",
	"_messageId": "",
	"_correlationId": "",
	"_subject": "",
	"_contentType": "application/json",
	"_replyTo": "",
	"_groupId": "",
	"_creationTime": "2026-10-01T14:03:12.512Z",
	"_timestamp": "2026-10-01T14:03:12.530Z",
	"_properties": {
		"line": "line1"
	},
	"value": {
		"temperature": 72.4
	}
}
FieldDescription
_addressThe address the message was sent to, or the input’s Address when the message does not include one.
_messageId, _correlationId, _subject, _contentType, _replyTo, _groupIdThe AMQP message properties. Properties the sender did not set are empty strings.
_creationTimeThe time the sender created the message. When the sender did not set one, the time the message was received.
_timestampThe time the Intelligence Hub received the message.
_propertiesThe message’s application properties as name/value pairs.
valueThe decoded payload.

Output Settings

SettingDescription
AddressThe broker node to send messages to. The address syntax is defined by the broker.
Persist MessagesWhen enabled, messages are marked durable so the broker persists them and they survive a broker restart. Enabled by default.
Message IdOptional message ID set on each message. When left blank, no message ID is set.
Include PropertiesWhen enabled, the Message Properties are attached to each message as AMQP application properties. Disabled by default.
Message PropertiesA list of Name/Value pairs to attach to each message. Name and Value are required, and names must be unique. Shown when Include Properties is enabled.

Each message is sent as JSON with the content type application/json, and its creation time is set to the time it is sent. A write completes when the broker accepts the message.