This article gives you an instructions for installing and activating the official Zendesk Emarsys add-on application in your Zendesk marketplace.
Installing the Zendesk Emarsys add-on
You can install the Emarsys application as follows:
- Go to the official Zendesk website.
- Click the Install button.
Read carefully and follow the instructions: Before activating the Zendesk Emarsys add-on.
Installing manually
The information of this section is deprecated!
This section describes legacy functionality that is no longer actively maintained by Emarsys.
For manual installation of the Zendesk Emarsys add-on, follow the steps below:
- Acquire the Zendesk Emarsys add-on as an archived
.zipfile from Emarsys. - Log in to the Zendesk website with Administrator credentials.
- Go to the Agent view.
- Click the gear icon in the left menu.
- Click Apps → Manage.
- Click Upload private app on the top-right.
- Type "emarsys" as the name of the application.
- Select the
.zipfile received from Emarsys. - Click Upload.
- Confirm the warning message.
- Install the Zendesk Emarsys add-on.
- Enter "TEST" when asked for a JSON Web Token (JWT) token.
- Inform Emarsys on the result of the installation.
Before getting started with the Zendesk Emarsys add-on
Once you have successfully installed the add-on perform the necessary steps for the proper activation and smoother setup.
Before activating the Zendesk Emarsys add-on
Contact the Emarsys Custom Integrations team (CUSTINT) as each activation request has to go through Emarsys. It is the Emarsys team's responsibility to ensure the following:
- Assign the necessary resources to Emarsys servers.
- Carry out the occurring customizations.
- Monitor any issues to provide a better starting experience.
The add-on activation request must be submitted as a CUSTINT ticket with the information listed:
- Customer id(s)
- Customer name(s)
- Environment(s)
- Zendesk URL(s)
- Widget(s)
- Predict (If you want to use Predict widgets)
- Merchant id
- Wether they use Predict user id and secret or an external id field
- Primary key
- Emarsys field that Emarsys can use to link Zendesk users to Emarsys users (e.g. email)
- Zendesk primary key to link the Emarsys field to Zendesk user. Needs to be one of the following:
- externalId (Setting and finding users external id)
- Custom_field (e.g. custom_field_16)
Activating your Zendesk Emarsys add-on
To perform the following steps you must be log in with Zendesk Administrator credentials to the Zendesk environment.
Once the Emarsys Custom Integrations team (CUSTINT) completed the pre-activation steps, synchronize their settings between Zendesk and Emarsys.
- Open your Zendesk Emarsys account.
- Go to the Activation tab in the add-on and click Activate.
- Wait while you are redirected to Zendesk.
- Confirm that Emarsys can change your Zendesk Emarsys add-on settings.
- Wait while Emarsys is synchronizing their settings with the Zendesk Emarsys add-on you installed.
You are redirected to Emarsys to a tab that is closing automatically after a few seconds. Do not close it manually!
6. When the configuration changes performed by Emarsys are completed you are provided a detailed list of them.
Your Zendesk Emarsys add-on is activated and ready to use.