zendesk connector by wagento commerce installation guide€¦ · installation guide v1.1 help...

Installation Guide v1.1

Zendesk Connector by Wagento Commerce

INSTALLATION GUIDE


Pre-requisites

In order to install and use the extension in your store, you will need the

following:

• PHP version 7.1.3 or greater, or PHP 7.2.0 or greater

• Magento version 2.2.1 or greater, or Magento version 2.3.0 or greater

(compatible with Magento Open Source, Magento Commerce and Magento

Commerce Cloud editions)

• Zendesk Account, if you don’t have an account, you can create one in

https://www.zendesk.com/register/#getstarted

• OAuth Client, configure it in

https://{yoursubdomain}.zendesk.com/agent/admin/api/oauth_clients • Replace {subdomain} with your configured subdomain when you’ve created your account.

http://www.zendesk.com/register/#getstarted


Zendesk Module for Magento 2

Installation

Zendesk extension URL in marketplace: https://marketplace.magento.com/wagento-zendesk.html

Step #1

● Extract .zip in <MAGENTO_ROOT>/app/code/Wagento/Zendesk (if directory doesn’t exist,

please create it)

Step #2

Commands Execution

Once you have the module files in your Magento installation, some commands execution are needed.

https://marketplace.magento.com/wagento-zendesk.html

https://marketplace.magento.com/wagento-zendesk.html


php bin/magento module:enable Wagento_Zendesk;

php bin/magento setup:upgrade;

php bin/magento setup:static-content:deploy;

php bin/magento cache:flush;

Step #3

Connector Configuration

1. OAuth Client Configuration

• Open https://{yoursubdomain}.zendesk.com/agent/admin/api/oauth_clients in any browser and click on [+]

OAuth Client view

• Fill in the information in the form. Among the fields most important fields are: o Redirect URLs - To avoid any communication problem, add this

variation of stores URL for call back https://{storeDomain}/zendesk o Unique Identifier – This is the client id for the OAuth connection


An alert message will appear

2. Click on save

Note: full secret text will be available only once, don’t forget to save it in a secure place.


3. Click Ok and Save secret.

Secret generated

Information Summary

After OAuth Client configuration is done information needed for Magento Zendesk module are:

● Subdomain: Zendesk account subdomain

● Client Id: Is the OAuth unique identifier

● Secret: Is the code generated at the end of steps

Example

● Subdomain: foozendesk

● Client Id: magento_2

● Secret: 4f7635a6658d57e5d0f9f59e53152653be879672c8078be48e4048a427df2004


Step #4

Getting Started

Dashboard View

If everything is installed correctly, you must be able to see a Zendesk option on the menu

on the left and a message requesting you to set up.

Store configuration

To access the Zendesk module configurations go to Zendesk > Configuration


Once you are on the configuration page, fill in the required fields and click on authorize

A popup will load to login with your Zendesk account and complete the Oauth


A token will be created


Ticket Configuration (you can get information in the User Guide)

Global Configuration

● Default Value for Type: Setting this will automatically choose by default the type of

ticket that will be created whenever your customers create a ticket from the ‘contact

us form’ in Magento 2

● Default Value for Status: Setting this will automatically choose by default the type of

ticket that will be created whenever your customers create a ticket from the ‘contact

us form’ in Magento 2

● Default Value for Priority: Setting this will automatically choose by default the type of

ticket that will be created whenever your customers create a ticket from the ‘contact us

form’ in Magento 2

● Include Order Number: Enabling this will add the the order number in the ticket

created if the customer is a registered user in Magento 2.


Frontend


This section is for controlling the different features that a Magento customer can use

and see in the Magento storefront

● Show Ticket List In Customer Account Menu: Add ‘My Tickets’ link in the

customer dashboard to view existing tickets for that customer

● Show Recent Ticket In Customer Dashboard:

● Show Order’s Ticket in Customer Account:

● Add “Open Ticket” Action To Order List: Allows the customer to create a ticket from

the Order list. Tickets created here

● Customer Can Comment in Ticket: Allows the customer to comment in a ticket in Magento 2

● Create Ticket from Contact Us: Automatically create a Support ticket when a

customer fills up the contact us form

Backend

●

Show Support Tickets In Customer View: Allows the Magento admin to view

the customers’ tickets in the customer information page

● Show Support Tickets In Order View: Allows the Magento admin to view

customers’ tickets linked to an Order


End-user Configuration

• Synchronize Customers: Allow the integration to automatically create a Zendesk

user when a Magento customer is created

• Attributes to Sync: Allows the integration to automatically fill up selected custom

fields in Zendesk for the Magento Customer

• Synchronize Customer Button: Manually copy all Magento 2 customers to Zendesk


Help Center Configuration

• Display Link To Zendesk Support in Magento Footer: Displays a link in the footer of the

Magento store that links to the Help Center of the Zendesk instance

• Include Web Widget: Displays the Zendesk Web Widget in the lower right corner of the

Magento storefront

Magento 2 Connector in Zendesk

• Install App Button: Clicking this will automatically install and setup the Magento 2 App in Zendesk Support to display order information of a customer

• Order Number Display Limit: Sets the maximum number of orders that can be displayed in the Magento 2 app


Magento 2 Connector app for Zendesk

Step #1

Installation

From Magento Admin [Recommended]

Best and easiest way to install Magento 2 Connector is from Magento store. After Zendesk

module is installed and configured (See Zendesk Module for Magento), just go to “Zendesk >

Configuration > Magento 2 APP in Zendesk" and click on “Install app” button.


Step #2

Once it is installed successfully you to your Zendesk agent account

https://{subdomain}.zendesk.com/agent/tickets/## for example

https://foozendesk.zendesk.com/agent/tickets/1


To setup manually:

This is a step by step installation and configuration for Magento 2 Connector.

Pre requirements

1. Create new Integration go to “System > Integration”


2. Click on add new integration

3. Set integration name as m2appzendesk and leave rest of General group

fields blank


4. Go to API tab, set Resource Access as Custom, from tree list check Zendesk > REST API

5. Before saving go to Integration Info tab and in Current User Identity Verification group

write your current admin user password.


From Save button select Save and Active


6. A popup will be show requesting you to give access click on Allow

7. In last popup will appear access information, save Access Token and click on Done


So after all steps information we need are:

• Store URL • Access Token

Sample data:

• Store URL: https://foomagentostore.com • Access Token: vfvd79qw3cni7kbt8h71l0029ckmk4lu

Getting Started

• In Zendesk Marketplace (https://www.zendesk.com/apps/) look for Magento 2 Connector app

• Click on install and app will require Domain and Token information

http://www.zendesk.com/apps/


• Once it is installed successfully you to your Zendesk agent account

https://{subdomain}.zendesk.com/agent/tickets/##

https://foozendesk.zendesk.com/agent/tickets/1


Support If you experience any issues or errors while using the extension, please open a ticket by sending a detailed e-mail to [email protected]. Be sure to include your store’s Web address (URL), PHP version, Magento version, a full description of the problem including steps to reproduce it and any other relevant information. We do our best to respond to all legitimate inquires within 48 business hours.

mailto:[email protected]


Uninstalling

If you experience an issue with the extension that cannot be remedied, or you no longer require its functionality, you can completely remove it from your store using one of the procedures found in this section.

Remove Directory From this path: your_magento_root/app/code/Wagento/Zendesk

php bin/magento setup:upgrade

php bin/magento setup:di:compile

php bin/magento static:content:deploy

zendesk connector by wagento commerce installation guide€¦ · installation guide v1.1 help...

Documents