Zendesk Magento 2 Connector – Install and Setup

Decorative underline



Step 1 – Install the Magento 2 Extension
Step 2 – Configure the Magento 2 Extension
Step 3 – Configure the Zendesk App
Sunshine Profiles and Events


  • Magento Open Source (CE): 2.3, 2.4
    Magento Commerce on Prem (EE): 2.3, 2.4
    Magento Commerce on Cloud (ECE): 2.3, 2.4

Step 1 - Install the Magento 2 Extension

Preferred Method

The preferred method is using a composer install using credentials from Magento Marketplace after you have added it to your marketplace account.

Use following command to install the module and all its dependencies.

					composer require classyllama/module-zendesk
bin/magento module:enable Zendesk_Zendesk
This page gives a thorough overview of the steps necessary to install a module. https://devdocs.magento.com/extensions/install/

Alternative Method

Alternatively, rather than installing via composer, you can download the code via My Purchases in the Magento Marketplace, and put it in the app/code directory of your site code.

If you do that, you will also need to install zendesk/zendesk_api_client_php, which you can do by running this in the command line.

					composer require zendesk/zendesk_api_client_php
bin/magento module:enable Zendesk_Zendesk

Step 2 - Configure the Magento 2 Extension

To configure the Magento 2 Extension the first step is to ensure that you allow for Token Based authentication in Magento and then generate an API Token in your Zendesk account.

  1. Ensure that token based authentication is enabled within Magento. This step is necessary until the extension supports OAuth which is scheduled for a future release.
    • Stores > Configuration > Services > OAuth > Consumer Settings > Allow OAuth Access Tokens to be used as standalone Bearer tokens option to Yes.
  2. To generate a token, log in to your Zendesk account then select Admin > Channels > API > Add API Token. If you do not see the “Add API Token” button be sure that Token Access is Enabled.
  3. Be sure to give the token a good description and then copy the token to be placed into Magento.
  4. Navigate to the Zendesk Configuration area of the Magento 2 Backend. Stores > Settings > Configuration > Zendesk > Zendesk and fill in the Zendesk domain, Agent Email Address , and paste the Agent token from the step above. Note when entering the Zendesk domain use only the subdomain, leaving out zendesk.com from the input field.
  5. Click Save Config at the top right. Note the four (4) success messages at the top of the page.
  6. You can choose which items you would like to display in Zendesk by selecting the Display options in the Zendesk App Settings area.
  7. If you would like to turn on the chat/messaging Widget on the front end of your store, select yes in the Customer Front End area.
  8. If you have multiple brands in Zendesk, these will need to be mapped to your Store Views in the Brand Mapping Area.
  9. Save Config and Flush Magento Cache.

Step 3 - Configure the Zendesk App

To configure your Zendesk account navigate to Admin > Apps & Integrations > Zendesk Support apps and select the Magento 2 Connector app.

  1. Confirm the Zendesk app was installed with the correct Magento Base Url field including the https:// and the trailing slash. For example: https://mymagentostore.com/
  2. The API token will be empty for security purposes but this token will have been obtained from Magento during the install process above.
  3. Check the Display settings you would like to see visible in the Zendesk App and enable role/group restrictions as desired.

Your Zendesk Magento 2 integration is now complete. Navigate to a ticket and open up the app area on the right where you will see the Magento 2 Connector. Create a ticket and set the email address of the Requester to a known email in Magento associated with an Order.

Sunshine Profiles and Events

Sunshine Profiles and Events for Magento currently only supports a single storefront and is in an Early Access Program (EAP).

If you’re interested in enabling Sunshine Profiles and Events for Magento please follow the instructions here and then enable the custom events in your Magento backend at Stores > Settings > Configuration > Zendesk > Sunshine.

Need more help?

First, check out the Troubleshooting Page for the Magento 2 Zendesk Integration. If that isn’t helpful you can Contact Support using the form below.


Ready to maximize your eCommerce Potential?

Let's Talk!

Contact Us