Skip to main content

AMQP Component

Send and receive messages on an AMQP-based message broker

Component key: amqp

Description#

The 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.

Actions#

Get Message#

Receives a message from any AMQP based queue | key: getMessage

InputKeyDefaultNotesExample

Host

string
/ Required
hostProvide the web address that your queue brokers are hosted on.192.168.0.1

Port

string
/ Required
port5672Provide the port that your queue brokers are hosted on.5672

Protocol

string
/ Required
protocolProvide the desired protocol in which you want to interact with the queue.

Queue Name

string
/ Required
queueNameProvide the name of the queue you would like to interact with.myQueue

Authorization#

Authorization is not required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

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      ]    }  }}

Publish Message#

Publishes one message to any AMQP Queue | key: publishMessage

InputKeyDefaultNotesExample

Host

string
/ Required
hostProvide the web address that your queue brokers are hosted on.192.168.0.1

Message

string
/ Required
messageProvide a message to push on to the queue.Message to Queue

Port

string
/ Required
port5672Provide the port that your queue brokers are hosted on.5672

Protocol

string
/ Required
protocolProvide the desired protocol in which you want to interact with the queue.

Queue Name

string
/ Required
queueNameProvide the name of the queue you would like to interact with.myQueue

Authorization#

Authorization is not required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

Output Example Payload#

{  "data": false}

Reject Message#

Rejects one message from an AMQP QUEUE | key: rejectMessage

InputKeyDefaultNotesExample

Host

string
/ Required
hostProvide the web address that your queue brokers are hosted on.192.168.0.1

Port

string
/ Required
port5672Provide the port that your queue brokers are hosted on.5672

Protocol

string
/ Required
protocolProvide the desired protocol in which you want to interact with the queue.

Queue Name

string
/ Required
queueNameProvide the name of the queue you would like to interact with.myQueue

Authorization#

Authorization is not required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

Output Example Payload#

{  "data": {    "consumerTag": "amq.ctag-ExampleTag"  }}