Connect Magento With Help Scout: View Customer Data in Sidebar

Magento is an open source, enterprise-level eCommerce platform with a product offering to suit businesses of all sizes. It gives online retailers everything they need to sell products to customers.

When you install the Magento app for Help Scout, you'll be able to import registered customer contact information, view key metrics such as lifetime value and average order value, and display 10 of your registered customers' most recent orders right in Help Scout. 

In this article

Connect Magento 2

1
Log in to Magento as an Administrator then head to System > Integrations. Click Add New Integration. Name the integration Help Scout, and enter help@helpscout.com as the email address on the Integration Info page, and enter your Magento password to authenticate. Leave Callback URL and Identity URL blank. Click API in the left navigation menu. 

2
Set Resource Access to Custom. Place a check mark in View under Sales > Operations > Orders > Actions

3
Scroll down a bit and check Actions under Customers > All Customers. Uncheck Delete, Reset password, and Invalidate tokens. Leave all other API Resources unchecked. Click Save in the top right corner. 

4
Click Activate from the Integration list, then click Allow on the following screen to confirm the API Resources. 

5
You'll be given the Consumer Key, Consumer Secret, Access Token, and Access Token Secret. Keep this page open and open Help Scout in a different tab or window. 

6
Head to Manage > Apps > Magento in Help Scout. Click Install App then select Version 2 and enter your Store URL, Consumer Key, Consumer Secret, Access Token, Access Token Secret, and Admin URL from Magento. Select the Mailboxes where you want the Magento sidebar to appear. Click Save

7
You can also add multiple Magento accounts. Click on the blue New Account link at the bottom of the page to add the new account, and follow steps #1-6. Make sure to save your settings.

8
You'll be able to label each shop to easily distinguish them within Help Scout.

Connect with Magento 1.9 or older

1
Head to  Manage > Apps > Magento. Select  Version 1.X from the Version dropdown list.
Note: Magento is discontinuing support for both Commerce 1 (the Enterprise Edition) and Open Source 1 (the Community Edition) as of June 2020, per Adobe. While we do not anticipate that this will affect your ability to connect with Help Scout, this will limit our ability to support the integration as well. 
2
This Magento integration requires an OAuth consumer. Login to your Magento Admin. From the top menu bar, click on System > Web Services > REST - OAuth Consumers. On the OAuth Consumers listing page, click the Add New button. Give the new consumer a name, such as helpscout. Copy both the Key and Secret for use in the Help Scout integration setup, and click Save. You should leave the Callback URL and Rejected Callback URL fields empty. Create a New OAuth Consumer
3
Set up the REST API service roles the Help Scout integration will use. From the top menu bar, click on System > Web Services > REST - Roles. Click Add Admin Role and enter Administrator and click Save Role. Click Role API Resources to the left and check each box named Retrieve and then click Save Role.
Create a New Role
Assign Role Resources
4
The new REST Administrator role needs to be be able to fetch order and customer attributes from the API. Click on System Assign Role Resources > Web Services > REST - Attributes. Choose the Administrator user type and then choose All for the Resource Access and click Save.
5
Give the user REST API access. Click on System > Permission > Users. Click on the user that you indent to use with this integration (usually this is your own user). Click the REST Role to the left and select the radio button in the Assigned column for the Administrator that you created in step two. Click Save User.
Assigning a REST Role
6
Set up the Help Scout integration with the Key and Secret that you saved in step one. This will allow the integration to identify itself to your server over a trusted connection. Open the integration settings page and enter both of these values and the appropriate URLs for your Magento server, and then click the blue Save button. You'll be directed to your Magento admin interface. You must choose to authorize the integration. You'll then be redirected back to the integration settings page, and your integration will be set up and running.

7
You can also add multiple Magento accounts. Click on the blue New Account link at the bottom of the page to add the new account, and follow steps #1-6. Make sure to save your settings.

8
You'll be able to label each shop to easily distinguish them within Help Scout.

Still stuck? How can we help? How can we help?