developer.helpscout.net
Docs API Overview - Help Scout Developers
http://developer.helpscout.net/docs-api
Each User has a Docs API key, which is separate from any help desk API keys. You can view or regenerate your key from your User Profile, on the API Keys. This is an HTTPS-only API. Authentication is based on API Keys. Each API Key is associated with a Help Scout user. Results returned from various responses are based upon the role of the user to which the API key is tied. To try the API via curl on the command-line, the general form used would be:. Curl - user API KEY:DUMMY PASSWORD API URL. Status: 200 ...
developer.helpscout.net
Create Webhook - Help Scout Developers
http://developer.helpscout.net/help-desk-api/hooks/create
Https:/ api.helpscout.net/v1/ hooks.json. Clients may create and configure up to one webhook per company. A webhook may be configured to receive multiple event notifications (e.g. conversation created, note added). Each request to this API will replace the existing webhook (if any) with the one specified in the request body. For more details about handling Help Scout's webhooks, see this overview. The list of events to subscribe to; the full list is detailed here.
developer.helpscout.net
Custom Apps - Help Scout Developers
http://developer.helpscout.net/custom-apps
Custom Apps enable you to pull data from a 3rd party source into the customer sidebar. Ideally, it would display information that adds context about the customer and your relationship; such as account level/plan, order history, how long they have been a customer or anything else that's important to your business. This example App (image to the right). Two Kinds of Custom Apps. Your custom App can take shape in one of two formats: Dynamic.
developer.helpscout.net
List Customers - Help Scout Developers
http://developer.helpscout.net/help-desk-api/customers/list
Https:/ api.helpscout.net/v1/ customers.json. Customers can be filtered on any combination of first name, last name, email, and modifiedSince. Https:/ api.helpscout.net/v1/customers.json? At this time all customers are returned by createdAt date (from newest to oldest). Returns customers that have been modified since the given date/time. Date/time is in UTC. Current page that was passed in on the request. Total number of pages available. Total number of objects available.
developer.helpscout.net
Conversation Object - Help Scout Developers
http://developer.helpscout.net/help-desk-api/objects/conversation
The following fields are returned when listing conversations. The type of conversation. ID of the Mailbox Folder. To which this conversation resides. The conversation number displayed in the UI. This number can be used in combination with the. To construct a URL to the conversation on the Help Scout website. Example:. Https:/ secure.helpscout.net/conversation/ id / number /. The Help Scout user who is currently assigned to this conversation. To which this conversation belongs. Hello, I tried to download ...
developer.helpscout.net
List Mailboxes - Help Scout Developers
http://developer.helpscout.net/help-desk-api/mailboxes/list
Https:/ api.helpscout.net/v1/ mailboxes.json. To request subsequent pages:. Https:/ api.helpscout.net/v1/mailboxes.json? Current page that was passed in on the request. Total number of pages available. Total number of objects available. Objects. Folders are not returned on the Mailbox objects on this call.
developer.helpscout.net
Customer Object - Help Scout Developers
http://developer.helpscout.net/help-desk-api/objects/customer
The following fields are returned when listing customers. Http:/ twitter.com/img/some-avatar.jpg. Type of photo. Possible values include:. Gender of this customer. Possible values include:. Greater Dallas/FT Worth Area. UTC time when this customer was created. UTC time when this customer was modified. In addition to the fields above, the following fields are returned when retrieving a single Customer. I've worked with Vernon before and he's really great. This is the Notes. Field from the user interface.
developer.helpscout.net
Conversations Report - Help Scout Developers
http://developer.helpscout.net/help-desk-api/reports/conversations/conversations
Https:/ api.helpscout.net/v1/ reports/conversations.json. The conversations report provides statistics about conversation volume over a given time range. You may optionally specify two time ranges to see how conversation volume changed between the two ranges. A variety of filters are available as query parameters. Including any of these will result in only conversations that match the filters being included in the report. Date/Time (ISO 8601, in UTC). Date/Time (ISO 8601, in UTC). List of tag identifiers.
developer.helpscout.net
API Clients - Help Scout Developers
http://developer.helpscout.net/help-desk-api/api-clients
We maintain two official API clients and encourage developer-built API clients as well. Official Help Scout Clients. Open source clients for Python, Ruby, Node.js and more are listed on the open source page. While not a true API client, this is an example of communicating with the API via JavaScript:. Https:/ javascriptbase64.googlecode.com/files/base64.js". Https:/ ajax.googleapis.com/ajax/libs/angularjs/1.2.19/angular.js". Help Scout API Key: input. Request sent, loading response.'.
developer.helpscout.net
List Users - Help Scout Developers
http://developer.helpscout.net/help-desk-api/users/list
Https:/ api.helpscout.net/v1/ users.json. To request subsequent pages:. Https:/ api.helpscout.net/v1/users.json? Current page that was passed in on the request. Total number of pages available. Total number of objects available. List Users by Mailbox.
