---
schema_version: "1"
id: 09d0a9feeec0086cedd4b61bdc4126b79b15dcd9f0505afc29592f286bd01c93
title: Anypoint MQ Connector Overview
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/anypoint-mq-connector/latest/index.md
canonical_url: https://docs.mulesoft.com/anypoint-mq-connector/latest/
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 833c8183bc60d93cc386421687f96e8c7f102cc8165ae21247334152d11dedaf
description: MuleSoft Documentation Site
release: 4.x
latest: true
---
---
product: Anypoint MQ Connector
version: 4.x
is-latest-version: true
---

# Anypoint MQ Connector Overview

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Connector for Anypoint MQ (Anypoint MQ Connector) provides publish-subscribe messaging to
Mule apps using the Anypoint MQ cloud service.

Anypoint MQ supports a wide range of messaging use cases, such as enterprise messaging patterns,
asynchronous communications between microservices, and IoT. Anypoint MQ also has a REST API for
publishing or consuming messages using frameworks such as node.js, Java, Go, and DevOps bash
scripts.

## Requirements

To use this connector, you must be familiar with Anypoint Studio, Anypoint Connectors, and
application flows. Anypoint MQ Connector is free, but connecting to the service in Anypoint Platform
requires a license.

### Compatibility

<table><colgroup><col> <col></colgroup><thead><tr><th>Software</th><th>Version</th></tr></thead><tbody><tr><td><p>Mule runtime engine</p></td><td><p>4.1.1 and later</p></td></tr><tr><td><p>Anypoint Studio</p></td><td><p>7 and later</p></td></tr></tbody></table>

This documentation applies to Anypoint MQ Connector 4.x only. To migrate from version 3.x to the
version 4.x, see
[Upgrading and Migrating Anypoint MQ Connector](https://docs.mulesoft.com/anypoint-mq-connector/latest/anypoint-mq-connector-upgrade-migrate).

## Install Anypoint MQ Connector

You can use this connector with apps written in Anypoint Studio, standalone apps, or apps written in
XML.

In Anypoint Studio:

1.  Create or open a Mule project.

2.  Click the **Exchange** icon in the Studio task bar.

3.  Enter your Anypoint Platform username and password and click **Sign in**.

4.  Select **All assets** and search for `MQ`.

5.  Select **Anypoint MQ Connector - Mule 4**, and click **Add to project**.

6.  Follow the prompts to install the connector.

For standalone apps or apps written in XML:

1.  Open your Mule project in Anypoint Studio.

2.  Add the connector as a dependency in the `pom.xml` file:

    ```xml
    <dependency>
      <groupId>com.mulesoft.connectors</groupId>
      <artifactId>anypoint-mq-connector</artifactId>
      <version>x.x.x</version>
      <classifier>mule-plugin</classifier>
    </dependency>
    ```

Replace `x.x.x` with the version that corresponds to the connector you are using.

To obtain the most up-to-date `pom.xml` file information, access the connector in
[Anypoint Exchange](https://www.mulesoft.com/exchange/) and click **Dependency Snippets**.

## Configure an Operation in a Mule Project

In Anypoint Studio:

1.  Install the connector, if it’s not already installed.

    See [Install Anypoint MQ Connector](#install-mq-connector).

2.  Create or open a Mule project.

3.  Search for `mq` in the **Mule Palette**.

4.  Click **Anypoint MQ** to see the available operations for the connector.

    ![The Mule Palette with Anypoint MQ Connector selected,  displaying the available operations](/mulesoft/current/en-us/anypoint-mq-connector/latest/_images/amq-4x-connector-palette.png)

5.  Configure the operation accordingly.

    <table><colgroup><col> <col></colgroup><thead><tr><th>Operation</th><th>Description</th></tr></thead><tbody><tr><td><p><a href="https://docs.mulesoft.com/anypoint-mq-connector/latest/anypoint-mq-ack">ACK</a></p></td><td><p>Indicates that the message was consumed correctly and deletes the message from <code>In Flight</code> status.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-mq-connector/latest/anypoint-mq-consume">Consume</a></p></td><td><p>Consumes messages from a queue.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-mq-connector/latest/anypoint-mq-ack">NACK</a></p></td><td><p>Changes the status of the message from <code>In Flight</code> to <code>In Queue</code> to be consumed again by an available consumer.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-mq-connector/latest/anypoint-mq-publish">Publish</a></p></td><td><p>Publishes messages to a destination.</p></td></tr><tr><td><p><a href="https://docs.mulesoft.com/anypoint-mq-connector/latest/anypoint-mq-listener">Subscriber</a></p></td><td><p>Listens for messages from a queue.</p></td></tr></tbody></table>

### Configure the Connection to the Default Subscriber

For each operation, you must configure a connection to a subscriber.

1.  In Anypoint Studio, drag the name of the operation from the **Mule Palette** to the canvas, and
    then select it.

2.  Click the green plus sign for **Connector configuration**.

3.  In Anypoint Platform, click **MQ > Destinations**.

4.  Click **Copy** and select **Connector version 4.x and later** from the menu:

    ![Copy button and menu with connector version options](/mulesoft/current/en-us/mq/_images/mq-tutorial-url.png)

5.  In Anypoint Studio, in the **Anypoint MQ Config** window, paste the URL in the **URL** field.

6.  In Anypoint MQ, click **MQ > Client Apps**.

    If needed, create a client app.

7.  Click the client app name to display the details pane.

8.  Copy the client app ID and client secret values from the details pane to the **Anypoint MQ
    Config** window in Studio:

    ![Global Element properties, including URL, client app ID, and client secret](/mulesoft/current/en-us/mq/_images/mq-tutorial-studio7-mq-config.png)

9.  Click **Test Connection** to verify the Anypoint MQ Default subscriber.

10. Click **OK**.

For more information, see
[Create and Connect a Mule 4 App to Anypoint MQ in Anypoint Studio 7](https://docs.mulesoft.com/mq/mq-tutorial#configure-mule-4-studio)
in the [Anypoint MQ Tutorial](https://docs.mulesoft.com/mq/mq-tutorial).

## See Also

- [Tutorial: Create a Queue and Send Messages to It](https://docs.mulesoft.com/mq/mq-tutorial)

- [FAQ: Anypoint MQ](https://docs.mulesoft.com/mq/mq-faq)

- [Anypoint MQ REST APIs](https://docs.mulesoft.com/mq/mq-apis)

- [Anypoint MQ Connector in Anypoint Exchange](https://anypoint.mulesoft.com/exchange/com.mulesoft.connectors/anypoint-mq-connector/)

- [Anypoint MQ Connector Release Notes for Mule 4](https://docs.mulesoft.com/release-notes/connector/anypoint-mq-connector-release-notes-mule-4)