Export / backup your Help Scout conversations
Switch branches/tags
Nothing to show
Clone or download
guenard Merge pull request #1 from stevenwadejr/patch-1
Fix mistyped function call
Latest commit 4cb66f8 May 30, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
CHANGELOG.md
LICENSE.md
README.md fix README May 14, 2018
composer.json set composer.json licence May 14, 2018
composer.lock
helpscout-exporter

README.md

Help Scout exporter

This small program lets you download your history of Help Scout email threads & conversations, either for backup purposes or because you are exporting your data archive to another platform. Help Scout is an email-based customer support / help desk service.

This program, written in PHP, uses Help Scout's Mailbox API 1.0 to:

  • get your mailboxes list
  • get the conversations into those mailboxes
  • get the email threads into those conversations

Exported data will be automatically written into JSON files under the supplied directory path:

  • mailboxes.json file will list mailboxes metadata.
  • conversations_{mailbox.id}.json files will list conversations and threads under these mailboxes.

Running this program might be slow if you have lots of conversations as it respects Help Scout API rate-limit of (only) 200 requests per minute. It is not possible to pause/restart the program as it will start all over again when you run it again later, creating potential duplicates in the output files. If the program stopped, you should clean previous files (eg: rm -R ~/helpscout-data/*.json) before restarting.

Requirements

  • PHP 5.6+ for the command line (eg: sudo apt-get install php-cli)
  • Composer the dependency manager for PHP (documentation)

Usage

1. Install the script with:

composer global require guenard/helpscout-exporter

Notes:

Add Composer global binaries to your path with export PATH=$HOME/.composer/vendor/bin:$PATH (add this line to your ~/.profile or ~/.bashrc).

2. Configure Help Scout API key:

In your terminal, set the Help Scout API key as an environment variable with:

export HELPSCOUT_API_KEY=YOUR_API_KEY_HERE

3. Run the exporter script:

helpscout-exporter -o ~/helpscout-data/ > ~/helpscout-export.log &

Notes:

To let the program run for a very long time a) prefix the command with nohup (will detach the process from your current terminal) and b) suffix the command with & (will move it in background).

4. Monitor the running exporter script:

# monitor output log in real-time
tail -f ~/helpscout-export.log
# number of conversations exported
cat ~/helpscout-data/conversations_*.json |grep '"threads":' |wc -l

Disclaimer

Help Scout (R) is a registered Trademark of Help Scout Inc.

This open-source script is not affiliated with Help Scout Inc.

Before using this script, please review Help Scout's Terms of Service.