=== HelpScout integration for Easy Digital Downloads ===
Contributors: webzunft, DvanKooten, Ibericode
Tags: easy-digital-downloads,helpscout,edd,support,help scout
Requires at least: 5.0
Tested up to: 5.7
Stable tag: 2.0
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Easy Digital Downloads integration for HelpScout. Shows purchase information right from your HelpScout interface.
== Description ==
HelpScout integration for Easy Digital Downloads is a WordPress plugin that will show customer information right from your HelpScout dashboard.
Activating the plugin and configuring the integration will add the following information to your HelpScout dashboard:
- The name of the customer and link to the profile page in EDD
- All payments by the customer (email address must match)
- A link to resent purchase receipts
- All purchased "downloads"
- The used payment method. Links to the transaction in PayPal or Stripe.
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.
**How to install and configure**
Have a look at the [installation instructions](https://wordpress.org/plugins/edd-helpscout/installation/).
> Please note that this plugin requires PHP 5.3 or higher.
**More information**
- Developers; follow or contribute to the [plugin on GitHub](https://github.com/webzunft/edd-helpscout)
- Other [WordPress plugins](https://profiles.wordpress.org/webzunft/#content-plugins) by Thomas Maier
== Installation ==
To get this up an running, you'll need to configure a few things in WordPress and HelpScout.
= WordPress =
1. Upload the contents of **edd-helpscout.zip** to your plugins directory, which usually is `/wp-content/plugins/`.
1. Activate the **HelpScout integration for Easy Digital Downloads** plugin
1. 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' );
`
= HelpScout =
1. Go to the [HelpScout custom app interface](https://secure.helpscout.net/apps/custom/).
1. 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`.
== Frequently Asked Questions ==
= HelpScout just shows "Invalid Signature" =
Make sure the "Secret Key" setting for your HelpScout application matches the value of your `HELPSCOUT_SECRET_KEY` constant. This key is used to authorize requests coming from HelpScout.
== Screenshots ==
1. Purchases and other information related to the customer is shown in the bottom right corner of your HelpScout interface.
== Changelog ==
= 2.0 =
The original developer Danny van Kooten stopped working on EDD HelpScout 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
= 1.0 =
Initial release.