{"id":33404,"date":"2014-12-14T16:25:05","date_gmt":"2014-12-14T16:25:05","guid":{"rendered":"https:\/\/wordpress.org\/plugins-wp\/edd-helpscout\/"},"modified":"2025-04-17T09:42:21","modified_gmt":"2025-04-17T09:42:21","slug":"edd-helpscout","status":"publish","type":"plugin","link":"https:\/\/scn.wordpress.org\/plugins\/edd-helpscout\/","author":13755043,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_crdt_document":"","version":"2.4.0","stable_tag":"2.4.0","tested":"6.8.5","requires":"6.0","requires_php":"7.4","requires_plugins":null,"header_name":"Easy Digital Downloads integration for Help Scout","header_author":"Thomas Maier","header_description":"","assets_banners_color":"d6d9dc","last_updated":"2025-04-17 09:42:21","external_support_url":"","external_repository_url":"","donate_link":"","header_plugin_uri":"https:\/\/webgilde.com","header_author_uri":"https:\/\/webgilde.com","rating":5,"author_block_rating":0,"active_installs":200,"downloads":14080,"num_ratings":28,"support_threads":0,"support_threads_resolved":0,"author_block_count":0,"sections":["description","installation","faq","changelog"],"tags":{"1.0.1":{"tag":"1.0.1","author":"DvanKooten","date":"2014-12-14 17:01:20"},"1.0.2":{"tag":"1.0.2","author":"DvanKooten","date":"2015-01-09 09:48:36"},"1.0.3":{"tag":"1.0.3","author":"DvanKooten","date":"2015-02-19 05:12:46"},"1.1":{"tag":"1.1","author":"DvanKooten","date":"2019-01-07 14:32:42"},"2.0":{"tag":"2.0","author":"webzunft","date":"2021-03-10 13:37:31"},"2.1":{"tag":"2.1","author":"webzunft","date":"2021-07-21 07:54:39"},"2.1.1":{"tag":"2.1.1","author":"webzunft","date":"2021-09-13 11:22:01"},"2.2.0":{"tag":"2.2.0","author":"webzunft","date":"2022-05-30 10:29:26"},"2.3.0":{"tag":"2.3.0","author":"webzunft","date":"2024-07-17 09:52:53"},"2.4.0":{"tag":"2.4.0","author":"webzunft","date":"2025-04-17 09:42:21"}},"upgrade_notice":[],"ratings":{"1":0,"2":0,"3":0,"4":0,"5":28},"assets_icons":{"icon-128x128.png":{"filename":"icon-128x128.png","revision":2553148,"resolution":"128x128","location":"assets","locale":""},"icon-256x256.png":{"filename":"icon-256x256.png","revision":2553148,"resolution":"256x256","location":"assets","locale":""}},"assets_banners":{"banner-1544x500.png":{"filename":"banner-1544x500.png","revision":2553148,"resolution":"1544x500","location":"assets","locale":""},"banner-772x250.png":{"filename":"banner-772x250.png","revision":2553149,"resolution":"772x250","location":"assets","locale":""}},"assets_blueprints":{},"all_blocks":[],"tagged_versions":["1.0.1","1.0.2","1.0.3","1.1","2.0","2.1","2.1.1","2.2.0","2.3.0","2.4.0"],"block_files":[],"assets_screenshots":{"screenshot-1.png":{"filename":"screenshot-1.png","revision":2553148,"resolution":"1","location":"assets","locale":""},"screenshot-2.png":{"filename":"screenshot-2.png","revision":2553148,"resolution":"2","location":"assets","locale":""},"screenshot-3.png":{"filename":"screenshot-3.png","revision":2553148,"resolution":"3","location":"assets","locale":""}},"screenshots":{"1":"Customer overview with Licenses area opened by default","2":"Orders with status, links to the store and payment provider","3":"Subscriptions with status and links to the store"},"jetpack_post_was_ever_published":false},"plugin_section":[],"plugin_tags":[5484,2665,11469,11468,1104],"plugin_category":[45],"plugin_contributors":[77662,77661,78768],"plugin_business_model":[],"class_list":["post-33404","plugin","type-plugin","status-publish","hentry","plugin_tags-easy-digital-downloads","plugin_tags-edd","plugin_tags-help-scout","plugin_tags-helpscout","plugin_tags-support","plugin_category-ecommerce","plugin_contributors-dvankooten","plugin_contributors-ibericode","plugin_contributors-webzunft","plugin_committers-flowdee","plugin_committers-webzunft","plugin_support_reps-webzunft"],"banners":{"banner":"https:\/\/ps.w.org\/edd-helpscout\/assets\/banner-772x250.png?rev=2553149","banner_2x":"https:\/\/ps.w.org\/edd-helpscout\/assets\/banner-1544x500.png?rev=2553148","banner_rtl":false,"banner_2x_rtl":false},"icons":{"svg":false,"icon":"https:\/\/ps.w.org\/edd-helpscout\/assets\/icon-128x128.png?rev=2553148","icon_2x":"https:\/\/ps.w.org\/edd-helpscout\/assets\/icon-256x256.png?rev=2553148","generated":false},"screenshots":[{"src":"https:\/\/ps.w.org\/edd-helpscout\/assets\/screenshot-1.png?rev=2553148","caption":"Customer overview with Licenses area opened by default"},{"src":"https:\/\/ps.w.org\/edd-helpscout\/assets\/screenshot-2.png?rev=2553148","caption":"Orders with status, links to the store and payment provider"},{"src":"https:\/\/ps.w.org\/edd-helpscout\/assets\/screenshot-3.png?rev=2553148","caption":"Subscriptions with status and links to the store"}],"raw_content":"<!--section=description-->\n<p>Help Scout integration for Easy Digital Downloads is a WordPress plugin that will show customer information right from your Help Scout dashboard.<\/p>\n\n<p>Activating the plugin and configuring the integration will add the following information to your Help Scout dashboard:<\/p>\n\n<ul>\n<li>The name of the customer and link to the profile page in EDD<\/li>\n<li>All purchased \"downloads\"<\/li>\n<li>Orders with status and link to payment providers<\/li>\n<\/ul>\n\n<p>If using the Software Licensing add-on, the following information is shown as well:<\/p>\n\n<ul>\n<li>License keys. Links to the site manager in Easy Digital Downloads.<\/li>\n<li>Active sites, with a link to deactivate the license for the given site.<\/li>\n<li>Links to purchase an upgrade directly<\/li>\n<\/ul>\n\n<p>When using Easy Digital Downloads with Recurring Payments:<\/p>\n\n<ul>\n<li>Subscriptions and their status<\/li>\n<\/ul>\n\n<p><strong>How to install and configure<\/strong><\/p>\n\n<p>Have a look at the <a href=\"https:\/\/wordpress.org\/plugins\/edd-helpscout\/installation\/\">installation instructions<\/a>.<\/p>\n\n<p>Please note that Help Scout changed their App interface. This plugin uses custom legacy apps, which you can learn more about <a href=\"https:\/\/secure.helpscout.net\/apps\/custom\">here<\/a>.<\/p>\n\n<p><strong>More information<\/strong><\/p>\n\n<ul>\n<li>Developers; follow or contribute to the <a href=\"https:\/\/github.com\/webzunft\/edd-helpscout\">plugin on GitHub<\/a><\/li>\n<li>Other <a href=\"https:\/\/profiles.wordpress.org\/webzunft\/#content-plugins\">WordPress plugins<\/a> by Thomas Maier<\/li>\n<\/ul>\n\n<!--section=installation-->\n<p>To get this up and running, you'll need to configure a few things in WordPress and Help Scout.<\/p>\n\n<h4>WordPress<\/h4>\n\n<ol>\n<li>Upload the contents of <strong>edd-helpscout.zip<\/strong> to your plugins directory, which usually is <code>\/wp-content\/plugins\/<\/code>.<\/li>\n<li>Activate the <strong>Help Scout integration for Easy Digital Downloads<\/strong> plugin<\/li>\n<li>Set the <strong>HELPSCOUT_SECRET_KEY<\/strong> constant in your <code>\/wp-config.php<\/code> file. This should be a random string of 40 characters.<\/li>\n<\/ol>\n\n<p><em>Example<\/em><\/p>\n\n<p>Replace <code>your-random-string<\/code> with your own random string.<\/p>\n\n<pre><code>define( 'HELPSCOUT_SECRET_KEY', 'your-random-string' );\n<\/code><\/pre>\n\n<h4>Help Scout<\/h4>\n\n<ol>\n<li>Go to the <a href=\"https:\/\/secure.helpscout.net\/apps\/custom\/\">Help Scout custom app interface<\/a>.<\/li>\n<li>Enter the following settings with adjustments according to your site\u2019s URL and the secret key.<\/li>\n<\/ol>\n\n<p><strong>App Name:<\/strong> Easy Digital Downloads<br \/>\n<strong>Content Type:<\/strong> Dynamic Content<br \/>\n<strong>Callback URL:<\/strong> https:\/\/YOUR-SITE.COM\/edd-helpscout-api\/customer_info <em>(I recommend using HTTPS)<\/em> <br \/>\n<strong>Secret Key:<\/strong> The value of your <strong>HELPSCOUT_SECRET_KEY<\/strong> constant.<\/p>\n\n<h4>Testing the plugin locally<\/h4>\n\n<p>You can set the plugin in some test mode.\nSet <code>HELPSCOUT_DUMMY_DATA<\/code> to <code>true<\/code> and <code>HELPSCOUT_DUMMY_DATA_EMAIL<\/code> to an email address in <code>wp-config.php<\/code> to let the plugin use dummy data.\nYou can then call https:\/\/your-site.com\/edd-helpscout-api\/customer_info directly and get a reply based on the value of <code>HELPSCOUT_DUMMY_DATA_EMAIL<\/code>.<\/p>\n\n<!--section=faq-->\n<dl>\n<dt id='help%20scout%20just%20shows%20%22invalid%20signature%22'><h3>Help Scout just shows \"Invalid Signature\"<\/h3><\/dt>\n<dd><p>Make sure the \"Secret Key\" setting for your Help Scout application matches the value of your <code>HELPSCOUT_SECRET_KEY<\/code> constant. This key is used to authorize requests coming from HelpScout.<\/p><\/dd>\n\n<\/dl>\n\n<!--section=changelog-->\n<h4>2.4.0<\/h4>\n\n<ul>\n<li>Increased required PHP version to 7.4<\/li>\n<li>Increased required WordPress version to 6.0<\/li>\n<li>Fix: PHP 8.2 deprecation notice, props @slaFFik<\/li>\n<\/ul>\n\n<h4>2.3.0<\/h4>\n\n<ul>\n<li>Improvement: added the <code>edd_helpscout_after_licenses_active_site_list_item<\/code> filter to extend output of activated sites<\/li>\n<li>Improvement: added the subscription id to endpoint data<\/li>\n<li>Fix: status badge of completed orders is now also green<\/li>\n<\/ul>\n\n<h4>2.2.1<\/h4>\n\n<ul>\n<li>Improvement: added the <code>edd_helpscout_after_subscription_list_item<\/code> action hook to allow adding elements to the Subscriptions view<\/li>\n<li>Improvement: increased required PHP version to 7.2<\/li>\n<li>Fix: typo in the installation instructions<\/li>\n<\/ul>\n\n<h4>2.2.0<\/h4>\n\n<ul>\n<li>Feature: the toggle state for Licenses, Orders, and Subscriptons sections is now persistent, props @nosilver4u on github<\/li>\n<li>Feature: display the number of items found for each section in the heading, props @nosilver4u on github<\/li>\n<li>Improvement: show \"Lifetime\" label for lifetime licenses, props @nosilver4u on github<\/li>\n<li>Improvement: override section templates by hosting your own version of them under <code>wp-content\/themes\/{THEME}\/edd-helpscout\/<\/code>, props @Spreeuw on github<\/li>\n<li>Improvement: added the <code>edd_helpscout_endpoint_html_sections<\/code> and <code>edd_helpscout_endpoint_html<\/code> filters to customize existing section templates, props @Spreeuw on github<\/li>\n<li>Improvement: added the <code>edd_helpscout_order_list_item_download_details_start<\/code> and <code>edd_helpscout_order_list_item_download_details_end<\/code> actions to order template, props @Spreeuw on github<\/li>\n<li>Improvement: added the <code>edd_helpscout_default_section_toggle<\/code> and <code>edd_helpscout_persist_section_toggle<\/code> filters to force a specific toggle state for sections, props @Spreeuw on github<\/li>\n<li>Improvement: increased required PHP version to 5.6 to sync with WordPress core<\/li>\n<\/ul>\n\n<h4>2.1.1<\/h4>\n\n<ul>\n<li>Improvement: check if emails field is empty and handle fallback to email field<\/li>\n<\/ul>\n\n<h4>2.1<\/h4>\n\n<ul>\n<li>complete template refactoring, e.g., to show Customer, Licenses, Orders and Subscriptions separately, props @Spreeuw<\/li>\n<li>refactor data collection, props @Spreeuw<\/li>\n<li>support EDD 3.0 and newer add-on versions, props @ashleyfae, @Spreeuw<\/li>\n<li>edd_helpscout_customer_licenses to filter license query response, props @Spreeuw<\/li>\n<li>changed \"HelpScout\" to \"Help Scout\" where technically reasonable<\/li>\n<\/ul>\n\n<h4>2.0<\/h4>\n\n<p>The original developer Danny van Kooten stopped working on EDD Help Scout since he no longer uses it.\nThe development of the plugin was taken over by Thomas Maier from https:\/\/wpadvancedads.com, who continues using the plugin.\nDanny 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.\nPlease test carefully and let me know in case something is missing or not working as expected.<\/p>\n\n<p><strong>Additions<\/strong><\/p>\n\n<ul>\n<li>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<\/li>\n<li>added name of the customer and link to the profile page in EDD since Help Scout doesn\u2018t show it for everyone<\/li>\n<li>set <code>HELPSCOUT_DUMMY_DATA<\/code> and <code>HELPSCOUT_DUMMY_DATA_EMAIL<\/code> constants in <code>wp-config.php<\/code> to let the plugin use dummy data<\/li>\n<\/ul>\n\n<p><strong>Improvements<\/strong><\/p>\n\n<ul>\n<li>fetch all payments when user has multiple emails in Help Scout or in his EDD profile<\/li>\n<\/ul>\n\n<p><strong>Fixes<\/strong><\/p>\n\n<ul>\n<li>Compatibility with latest EDD plugin versions.<\/li>\n<\/ul>\n\n<h4>1.1.1 - January 28, 2016<\/h4>\n\n<p><strong>Fixes<\/strong><\/p>\n\n<ul>\n<li>Certain characters at start of URL were being stripped off in HelpScout.<\/li>\n<\/ul>\n\n<h4>1.1 - September 6, 2015<\/h4>\n\n<p><strong>Fixes<\/strong><\/p>\n\n<ul>\n<li>The plugin is now listening at a later hook in the WP request lifecycle, which prevents issues with bbPress and EDD Wishlists.<\/li>\n<\/ul>\n\n<p><strong>Improvements<\/strong><\/p>\n\n<ul>\n<li>Code refactoring for better separation of concerns and better overall code readability<\/li>\n<li>Better naming consistency<\/li>\n<\/ul>\n\n<p><strong>Additions<\/strong><\/p>\n\n<ul>\n<li>Support for lifetime licenses in Easy Digital Downloads<\/li>\n<li>Various action hooks to output your own HTML<\/li>\n<\/ul>\n\n<h4>1.0.3 - February 19, 2015<\/h4>\n\n<p><strong>Fixes<\/strong><\/p>\n\n<ul>\n<li>Added protocol for links to active sites<\/li>\n<li>Querying payments by multiple emails was not working<\/li>\n<\/ul>\n\n<p><strong>Additions<\/strong><\/p>\n\n<ul>\n<li>When using EDD Software Licensing, show if a license is expired.<\/li>\n<li>Added <code>helpscout_edd_customer_emails<\/code> hook to filter customer emails<\/li>\n<\/ul>\n\n<h4>1.0.2<\/h4>\n\n<p><strong>Improvements<\/strong><\/p>\n\n<ul>\n<li>The plugin used to \"listen\" to all requests to the site. It will now (after confirmation) only listen to requests to <code>\/edd-hs-api\/customer-data.json<\/code>.<\/li>\n<\/ul>\n\n<h4>1.0.1<\/h4>\n\n<p><strong>Fixed<\/strong><\/p>\n\n<ul>\n<li>Issue with nonces not working properly for the admin actions. Now using the HelpScout signature to validate requests.<\/li>\n<\/ul>\n\n<p><strong>Improvements<\/strong><\/p>\n\n<ul>\n<li>Minor code &amp; inline documentation improvements<\/li>\n<\/ul>\n\n<p><strong>Additions<\/strong><\/p>\n\n<ul>\n<li>Added \"renewal\" label to renewals<\/li>\n<\/ul>","raw_excerpt":"Easy Digital Downloads integration for Help Scout. Shows purchase information right from your Help Scout interface.","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/scn.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin\/33404","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/scn.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin"}],"about":[{"href":"https:\/\/scn.wordpress.org\/plugins\/wp-json\/wp\/v2\/types\/plugin"}],"replies":[{"embeddable":true,"href":"https:\/\/scn.wordpress.org\/plugins\/wp-json\/wp\/v2\/comments?post=33404"}],"author":[{"embeddable":true,"href":"https:\/\/scn.wordpress.org\/plugins\/wp-json\/wporg\/v1\/users\/flowdee"}],"wp:attachment":[{"href":"https:\/\/scn.wordpress.org\/plugins\/wp-json\/wp\/v2\/media?parent=33404"}],"wp:term":[{"taxonomy":"plugin_section","embeddable":true,"href":"https:\/\/scn.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_section?post=33404"},{"taxonomy":"plugin_tags","embeddable":true,"href":"https:\/\/scn.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_tags?post=33404"},{"taxonomy":"plugin_category","embeddable":true,"href":"https:\/\/scn.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_category?post=33404"},{"taxonomy":"plugin_contributors","embeddable":true,"href":"https:\/\/scn.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_contributors?post=33404"},{"taxonomy":"plugin_business_model","embeddable":true,"href":"https:\/\/scn.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_business_model?post=33404"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}