Skip to main content

This library allows you to interact with HelpScout using Python.

Project description

|License MIT| | |PyPi Package| | |PyPi Versions|

|Build Status| | |Test Coverage| | |Code Climate|


This library allows you to interact with HelpScout using Python.

* `Read The API Documentation <>`_

.. contents:: Table of Contents


Installation is easiest using Pip and PyPi::

pip install helpscout

If you would like to contribute, or prefer Git::

git clone
cd python-helpscout
pip install -r requirements.txt
pip install .


The `HelpScout object <>`_
is the primary point of interaction with the HelpScout API.


Connecting to the HelpScout API will require an API Key, which is generated from
within your HelpScout account. In the below example, our key is ``API_KEY``.

.. code-block:: python

from helpscout import HelpScout
hs = HelpScout('API_KEY')

API Endpoints

The HelpScout API endpoints are exposed as variables on the instantiated ``HelpScout``
object. The available endpoints are:

* `Conversations <>`_
* `Customers <>`_
* `Mailboxes <>`_
* `Tags <>`_
* `Teams <>`_
* `Users <>`_
* `WebHook <>`_

They can also be viewed from the ``__apis__`` property of ``HelpScout``::

>>> hs.__apis__
{'Conversations': <helpscout.auth_proxy.AuthProxy object at 0x10783ddd0>,
'Customers': <helpscout.auth_proxy.AuthProxy object at 0x10783dd90>,
'Mailboxes': <helpscout.auth_proxy.AuthProxy object at 0x10783ded0>,
'Users': <helpscout.auth_proxy.AuthProxy object at 0x10783df50>,
'Teams': <helpscout.auth_proxy.AuthProxy object at 0x10783df10>,

API usage is as simple as calling the method with the required parameters and
iterating the results:

.. code-block:: python

for customer in hs.Customers.list(first_name='Help', last_name='Scout'):

The output from the above would look something like the below when using the
HelpScout demo data:

.. code-block:: python

# This is the customer object itself (first print)
<helpscout.models.customer.Customer object at 0x10783df10>
# This is the serialized form of the customer (second print)
{'chats': [],
'social_profiles': [],
'first_name': u'Help',
'last_name': u'Scout',
'phones': [],
'created_at': '2017-09-16T18:38:37Z',
'modified_at': '2017-09-16T18:38:37Z',
u'__class__': 'Customer',
'websites': [],
'id': 143161083,
'location': u'Boston, MA',
'full_name': u'Help Scout',
'gender': 'unknown',
'photo_type': 'gravatar',
'type': 'customer',
'emails': [],
'photo_url': u''}

In some instances, such as in the case of browsing for a record by its ID, a
singleton is expected. In these instances, the singleton is directly used
instead of iterated

.. code-block:: python

>>> customer = hs.Customers.get(143161083)
>>> customer
<helpscout.models.customer.Customer object at 0x101723e50>
>>> from pprint import pprint
>>> pprint(customer.serialize())
{u'__class__': 'Customer',
'address': {u'__class__': 'Address',
'city': u'Boston',
'country': u'US',
'created_at': '2017-09-16T18:38:37Z',
'id': 4996350,
'lines': [u'131 Tremont Street', u'3rd Floor'],
'postal_code': u'02111-1338',
'state': u'MA'},
'chats': [],
'created_at': '2017-09-16T18:38:37Z',
'emails': [{u'__class__': 'Email',
'id': 189240662,
'location': 'work',
'value': u''}],
'first_name': u'Help',
'full_name': u'Help Scout',
'gender': 'unknown',
'id': 143161083,
'last_name': u'Scout',
'location': u'Boston, MA',
'modified_at': '2017-09-16T18:38:37Z',
'phones': [{u'__class__': 'Phone',
'id': 189240668,
'location': 'work',
'value': u'855-435-7726'}],
'photo_type': 'gravatar',
'photo_url': u'',
'social_profiles': [{u'__class__': 'SocialProfile',
'id': 189240667,
'type': 'twitter',
'value': u''},
{u'__class__': 'SocialProfile',
'id': 189240663,
'type': 'twitter',
'value': u''},
{u'__class__': 'SocialProfile',
'id': 189240664,
'type': 'twitter',
'value': u''}],
'type': 'customer',
'websites': [{u'__class__': 'Website',
'id': 189240670,
'value': u''},
{u'__class__': 'Website',
'id': 189240665,
'value': u''},
{u'__class__': 'Website',
'id': 189240666,
'value': u''},
{u'__class__': 'Website',
'id': 189240671,
'value': u''}]}

Note that all of the API responses will be parsed, with proper objects being
created from the results. The objects are all defined in the `helpscout.models
package <>`_.


The ``.search()`` method is implemented for the following endpoints:

* `Conversations
* `Customers

Search accepts either an instantiated `Domain <
python-helpscout/helpscout.domain.html#helpscout.domain.Domain>`_, or an
`iterator of queries <

.. code-block:: python

[('subject', 'Test1'),
('subject', 'Test2')',
('subject', 'Test3')',

The above is equivalent to a HelpScout query string of::

(subject:'Test1' OR subject:'Test2' OR subject:'Test3')

Following is a usage example:

.. code-block:: python

>>> res =[('subject', 'Learning')])
>>> for r in res:
>>> r.serialize()
{'status': 'active', 'customer_email': u'', 'thread_count': 0, 'modified_at': '2017-09-16T18:38:37Z', 'number': 150, 'subject': u'Learning the basics', u'__class__': 'SearchConversation', 'has_attachments': False, 'mailbox_id': 122867, 'preview': u'Hey Dave, Above this message is what we call the Conversation Toolbar. From there you can take all sorts of actions on a Conversation. Hover your mouse over each of the icons to see what you can do....', 'id': 432907900, 'customer_name': u'Help Scout'}

Web Hooks

`Web Hooks <
web_hook.html#helpscout.web_hook.web_hook.HelpScoutWebHook>`_ can be received by
instantiating a `WebHook <
helpscout.web_hook.html#helpscout.web_hook.web_hook.HelpScoutWebHook>`_ using
the secret key that was configured while setting up the hook in your
HelpScout account:

.. code-block:: python

from helpscout import HelpScoutWebHook

hook = HelpScoutWebHook('your secret key')

In order to actually receive the request, call the `receive method
#helpscout.web_hook.web_hook.HelpScoutWebHook.receive>`_ on the instantiated

.. code-block:: python

signature = '2iFmnzC8SCNVF/iNiMnSe19yceU=\n' # (``X-HelpScout-Signature`` Header)
event_type = 'customer.created' # (``X-HelpScout-Event`` Header)
request_body = '{"firstName":"Jackie","lastName":"Chan",' \
'"email":"",' \

event = web_hook.receive(
event_type, signature, request_body,

The ``WebHookEvent`` that is returned contains two properties:

* ``event_type`` (*str*): The type of event that is being represented
* ``record`` (*helpscout.BaseModel*): The parsed data record for this request

Given the above example:

.. code-block:: python

>>> event.event_type
>>> event.record
<helpscout.models.customer.Customer object at 0x101723e50>

Creating web hooks is

Known Issues / RoadMap

* Add better validations (like regexes for emails)
* Verify required attributes, particularly when creating for API instead of
* Attachment handling in Conversations (Create/Delete Attachment)
* Raw email source handling in Conversations (Get Thread Source)
* Implement List Customers by Mailbox
* Implement Workflows
* Implement index lookup for the RequestPaginator (currently only response
iteration is supported)
* Make the domain add syntax more robust (right now AND + OR don't combine well)
* Docs API is not implemented



* Dave Lasley <>
* Brent Hughes <>


.. image::
:alt: LasLabs Inc.

This module is maintained by LasLabs Inc.

.. |Build Status| image::
.. |Test Coverage| image::
.. |Code Climate| image::
.. |License MIT| image::
:alt: License: MIT
.. |PyPi Package| image::
:alt: PyPi Package
.. |PyPi Versions| image::
:alt: PyPi Versions

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for helpscout, version 0.0.8
Filename, size File type Python version Upload date Hashes
Filename, size helpscout-0.0.8.tar.gz (34.8 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page