Help Scout integration for Easy Digital Downloads

Description

Help Scout integration for Easy Digital Downloads is a WordPress plugin that will show customer information right from your Help Scout dashboard.

Activating the plugin and configuring the integration will add the following information to your Help Scout dashboard:

  • The name of the customer and link to the profile page in EDD
  • All purchased “downloads”
  • Orders with status and link to payment providers

If using the Software Licensing add-on, the following information is shown as well:

  • License keys. Links to the site manager in Easy Digital Downloads.
  • Active sites, with a link to deactivate the license for the given site.
  • Links to purchase an upgrade directly

When using Easy Digital Downloads with Recurring Payments:

  • Subscriptions and their status

How to install and configure

Have a look at the installation instructions.

Please note that this plugin requires PHP 5.3 or higher.

More information

Screenshots

  • Customer overview with Licenses area opened by default
  • Orders with status, links to the store and payment provider
  • Subscriptions with status and links to the store

Installation

To get this up an running, you’ll need to configure a few things in WordPress and Help Scout.

WordPress

  1. Upload the contents of edd-helpscout.zip to your plugins directory, which usually is /wp-content/plugins/.
  2. Activate the Help Scout integration for Easy Digital Downloads plugin
  3. Set the HELPSCOUT_SECRET_KEY constant in your /wp-config.php file. This should be a random string of 40 characters.

Example

define( 'HELPSCOUT_SECRET_KEY', 'your-random-string' );

Help Scout

  1. Go to the Help Scout custom app interface.
  2. Enter the following settings.

App Name: Easy Digital Downloads
Content Type: Dynamic Content
Callback URL: https://your-site.com/edd-helpscout-api/customer_info (I recommend using HTTPS)
Secret Key: The value of your HELPSCOUT_SECRET_KEY constant.

Testing the plugin locally

You can set the plugin in some test mode.
Set HELPSCOUT_DUMMY_DATA to true and HELPSCOUT_DUMMY_DATA_EMAIL to an email address in wp-config.php to let the plugin use dummy data.
You can then call https://your-site.com/edd-helpscout-api/customer_info directly and get a reply based on the value of HELPSCOUT_DUMMY_DATA_EMAIL.

FAQ

Help Scout just shows “Invalid Signature”

Make sure the “Secret Key” setting for your Help Scout application matches the value of your HELPSCOUT_SECRET_KEY constant. This key is used to authorize requests coming from HelpScout.

Reviews

مئی 20, 2019
We have been using this for a couple of years. Works amazingly well. Huge timesaver!
مئی 20, 2019
Using the plugin on two websites with thousands of customers, and the plugin has saved us hours of time and efforts! It's easy to look up customer records with a single click and manage their Licenses. Thanks a ton, Thomas, for sharing your fantastic work with us!
مارچ 15, 2019
If you are using Easy Digital Downloads, and run your support through Helpscout this plugin is a must. It's really simple, and it works. It saves me tons of time looking up customer records, licences, processing refunds, etc. Really makes Helpscout a much more viable tool for running your customer support and technical support. @webzunft Thank you so much for taking this plugin over and getting it working again. I was rather upset when it stopped working, and appeared to be no longer supported.
پروری 25, 2019
This plugin is indispensable for an EDD shop using Help Scout. It bridges the gap between the two apps, saving support agents time. It works perfectly. Thank you Thomas for picking up development of the plugin and Danny for launching it years ago.
پروری 25, 2019
Thanks for the updating the plugin, and for your support, this plugin has been very useful.
اگست 23, 2017
This plugin just works. The quality of our support, and also my entire life, is skyrocketing due to being able to see customer data in HelpScout. Thanks!
Read all 23 reviews

Contributors & Developers

“Help Scout integration for Easy Digital Downloads” is open source software. The following people have contributed to this plugin.

Contributors

Changelog

2.1

  • complete template refactoring, e.g., to show Customer, Licenses, Orders and Subscriptions separately, props @Spreeuw
  • refactor data collection, props @Spreeuw
  • support EDD 3.0 and newer add-on versions, props @ashleyfae, @Spreeuw
  • edd_helpscout_customer_licenses to filter license query response, props @Spreeuw
  • changed “HelpScout” to “Help Scout” where technically reasonable

2.0

The original developer Danny van Kooten stopped working on EDD Help Scout since he no longer uses it.
The development of the plugin was taken over by Thomas Maier from https://wpadvancedads.com, who continues using the plugin.
Danny left in the middle of developing a better version 2.0. I decided to build in top of that because the changes show a lot potential and fixed some issues.
Please test carefully and let me know in case something is missing or not working as expected.

Additions

  • callback URL changed from https://your-site.com/edd-helpscout/api to https://your-site.com/edd-helpscout-api/customer_info, though both are working for now
  • added name of the customer and link to the profile page in EDD since Help Scout doesn‘t show it for everyone
  • set HELPSCOUT_DUMMY_DATA and HELPSCOUT_DUMMY_DATA_EMAIL constants in wp-config.php to let the plugin use dummy data

Improvements

  • fetch all payments when user has multiple emails in Help Scout or in his EDD profile

Fixes

  • Compatibility with latest EDD plugin versions.

1.1.1 – January 28, 2016

Fixes

  • Certain characters at start of URL were being stripped off in HelpScout.

1.1 – September 6, 2015

Fixes

  • The plugin is now listening at a later hook in the WP request lifecycle, which prevents issues with bbPress and EDD Wishlists.

Improvements

  • Code refactoring for better separation of concerns and better overall code readability
  • Better naming consistency

Additions

  • Support for lifetime licenses in Easy Digital Downloads
  • Various action hooks to output your own HTML

1.0.3 – February 19, 2015

Fixes

  • Added protocol for links to active sites
  • Querying payments by multiple emails was not working

Additions

  • When using EDD Software Licensing, show if a license is expired.
  • Added helpscout_edd_customer_emails hook to filter customer emails

1.0.2

Improvements

  • The plugin used to “listen” to all requests to the site. It will now (after confirmation) only listen to requests to /edd-hs-api/customer-data.json.

1.0.1

Fixed

  • Issue with nonces not working properly for the admin actions. Now using the HelpScout signature to validate requests.

Improvements

  • Minor code & inline documentation improvements

Additions

  • Added “renewal” label to renewals