AMQP Component
Send and receive messages on an AMQP-based message broker
Component key: amqp#
DescriptionThe Advanced Message Queuing Protocol (AMQP) is a standard protocol for interacting with message brokers and queueing platforms. It is used by many common message broker services like Azure Event Hubs, Apache Qpid, RabbitMQ and more.
This component allows you to manage messages on an AMQP-based queue.
#
AMQP Connections#
AMQP ConnectionInput | Default | Notes |
---|---|---|
Input Host string / Required | Default 192.168.0.1 | Notes The IP address or endpoint of the AMQP server |
Input Password string | Default | Notes This can be omitted if the AMQP server allows anonymous authentication |
Input Port string / Required | Default 5672 | Notes The port of the AMQP server |
Input Protocol string / Required | Default amqp | Notes Provide the desired protocol in which you want to interact with the queue. |
Input Username string | Default | Notes This can be omitted if the AMQP server allows anonymous authentication |
Input Vhost string | Default | Notes The "example/vhost" portion of amqps://amqp.example.com:5672/example/vhost |
#
Actions#
Check AMQP ConnectionVerify that an AMQP server is available, and return the server's connection information. This is helpful for debugging purposes. | key: checkConnection
Input | Notes |
---|---|
Input Connection connection / Required | Notes |
#
Output Example Payload{ "data": { "host": "amqp.example.com", "copyright": "Copyright (c) 2007-2022 VMware, Inc. or its affiliates.", "information": "Licensed under the MPL 2.0. Website: https://rabbitmq.com", "platform": "Erlang/OTP 24.2.1", "product": "RabbitMQ", "version": "3.9.13", "connection": { "host": "amqp.example.com", "port": "5672", "vhost": "example/vhost", "password": "myPassword", "protocol": "amqp", "username": "myUsername" } }}
#
Get MessageReceives a message from an AMQP-based queue | key: getMessage
Input | Default | Notes | Example |
---|---|---|---|
Input Acknowledge Message boolean | Default true | Notes Automatically mark the message received as "Acknowledged" | Example |
Input Connection connection / Required | Default | Notes | Example |
Input Queue Name string / Required | Default | Notes Provide the name of the queue you would like to interact with. | Example myQueue |
This action will return a message from a given queue, if a message is available to get.
If no message is available, this action will return null
.
You can pair this action with a branch step in order to process the message only if there is a message to process.
#
Output Example Payload{ "data": { "fields": { "deliveryTag": 1, "redelivered": true, "routingKey": "classic", "messageCount": 10 }, "properties": { "contentType": "text", "contentEncoding": "", "deliveryMode": "exampleMode", "priority": "High", "correlationId": "exampleId", "replyTo": "", "expiration": "", "messageId": "exampleId", "timestamp": "Fri, 06 Aug 2021 00:00:00 GMT", "type": "Buffer", "userId": "exampleId", "appId": "exampleId", "clusterId": "exampleId" }, "content": { "type": "Buffer", "data": [ 69, 120, 97, 109, 112, 108, 101, 32, 77, 101, 115, 115, 97, 103, 101, 32, 67, 111, 110, 116, 101, 110, 116 ] }, "message": "Example Message Content" }}
#
Publish MessageAdd a message to an AMQP-based queue | key: publishMessage
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Message string / Required | Notes Provide a message to push on to the queue. | Example Message to Queue |
Input Queue Name string / Required | Notes Provide the name of the queue you would like to interact with. | Example myQueue |
#
Output Example Payload{ "data": true}
#
Reject MessageRejects one message from an AMQP-based queue | key: rejectMessage
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Queue Name string / Required | Notes Provide the name of the queue you would like to interact with. | Example myQueue |
#
Output Example Payload{ "data": { "consumerTag": "amq.ctag-ExampleTag" }}