Important product naming update: Sidekick is now called Gladly (AI) and Gladly Hero (the Platform) is now Gladly Team. Please keep this in mind as you read through our documentation.

Magento App Platform Installation

Prev Next

The Magento app is set up entirely from Gladly's Settings, with no command-line tools required. Once it is connected, your team sees each Customer's Magento account, recent orders and shipment tracking on the Customer Profile. You will need a Magento administrator account that can create integrations.

Step 1: Create an integration in Magento

In Magento admin, go to System > Extensions > Integrations and click Add New Integration. Give it a name such as Gladly and enter your admin password. On the API tab, choose All resources, or a custom set that can read customers, sales orders and shipments, products, and product attributes. Gladly only reads data from Magento. Click Save.

Step 2: Activate it and copy the credentials

Back on the Integrations page, click Activate next to the new integration, then Allow. Magento shows four values: the consumer key, consumer secret, access token and access token secret. Copy all four.

Step 3: Note your host and admin address

  • Host: your store's address without https://, for example mystore.com.

  • Admin address: the start of any Magento admin page, up to and including the admin path, for example https://mystore.com/admin. Gladly adds the rest to link to each order and customer.

Step 4: Open the Apps settings

In Gladly, go to Settings > Apps. This is where you manage your App Platform integrations.

Step 5: Create a configuration

Click Create Configuration. When prompted for the External App, choose the Magento app (gladly.com/Magento_V2) and select the latest version available. Enter the host and admin address from Step 3 and the four credentials from Step 2.

Switch the configuration to active and save it.

Step 6: Add the card to the Customer Profile

Go to Settings > Agent Experience > Customer Profile and add the App Platform Card for the Magento card.

If the integration cannot read product attributes, the card still works but does not show each item's size and color.

Step 7: Choose what Gladly AI can use

Go to Settings > Agent Experience > Agent Actions and choose whether Gladly AI can use the order lookup action. This app has no agent forms.

Contact Support

Users assigned the Team Manager or Administrator roles can contact Gladly Support. Log into Gladly as one of these roles, click the hamburger menu on the top-left corner, then click Contact Gladly Support. Gladly Support's primary operating hours are Monday through Friday, 6 AM to 6 PM Pacific Time, but you can submit a request anytime.

  • Please select the correct business impact (P1 to P4).

  • Most requests should be sent as a P4.