Project

helpscout

0.06
No release in over 3 years
Low commit activity in last 3 years
There's a lot of open issues
HelpScout API Wrapper
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.2.3
~> 1.8.4
>= 0
~> 1.2.8

Runtime

 Project Readme

Helpscout Developers API gem

This gem is in beta.

Usage

  1. Follow the instructions at Help Scout's Developers site to generate an API key.

  2. Initialize your HelpScout client

helpscout = HelpScout::Client.new(HELPSCOUT_API_KEY)

Fetching Users

users = helpscout.users

Fetching Mailboxes

mailboxes = helpscout.mailboxes

Fetching Customers

customers = helpscout.customers

Fetching Conversations

To fetch active conversations:

conversations = helpscout.conversations(mailboxId, "active", nil)