Skip to main content
Skip table of contents

Magento 2

Magento 2 Setup

To authenticate the connector, you need to create an API Key:

  1. Log in to the Magento 2 admin portal, and select System > Extensions > Integrations.

  2. Select Add New Integration.

  3. Enter a unique name for the integration in the Name field, enter your admin password in the Your Password field, and leave all the other fields blank.

  4. Select the API tab, set Resource Access to All, and then select Save.

  5. Select the Activate link next to your new integration.

  6. Select Allow and copy the value in the Access Token field (not the Consumer Key).

Cyclr account setup

Cyclr asks you for the below values when you install the Magento 2 connector into an account:




The domain of your Magento 2 site, for example,


The API Key from your Magento 2 account.

Note: You can use different details for different accounts

Bulk endpoints

To use bulk methods such as Bulk Update Product, you need to enable/install asynchronous functionality and RabbitMQ on your Magento 2 instance. For more information, see the Magento documentation on bulk endpoints.

Custom Methods

The Magento 2 connector allows you to create custom methods for custom endpoints. You can create these methods with the custom objects in the Custom Method category.

Set up a custom object

When you set up a custom object, Cyclr creates a new method category with the endpoint you enter. To set up a custom object:

  1. Go to the Magento 2 connector's Settings page.

  2. Under the Methods and Fields heading, expand the Custom Methods category.

  3. Select the red Copy this Category to create a Custom Object Category icon.

  4. Enter the required custom method endpoint into Specify object name.

  5. Select Copy.

This creates a new custom object category with the specified method endpoint. You can run the GET or POST methods from the new category to call the specified endpoint. You need to map all of the request and response fields manually.


If you want to use webhooks with Magento 2, Cyclr has a dedicated Magento 2 Webhooks connector and a plugin that you can install in your Magento 2 instance.

For more information, see our Magento 2 Webhooks connector documentation.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.