The Help Scout API provides programmatic access to customer support functionalities, allowing the automation of ticketing, customer communication, and reporting tasks. With this API, you can read and send messages, manage conversations, work with mailboxes, create and update customers’ information, and generate reports. Utilizing the API on Pipedream, you can automate workflows that respond to events in Help Scout in real-time, integrate customer support data with other business tools, and streamline support operations.
import { axios } from "@pipedream/platform"
export default defineComponent({
props: {
help_scout: {
type: "app",
app: "help_scout",
}
},
async run({steps, $}) {
return await axios($, {
url: `https://api.helpscout.net/v2/users/me`,
headers: {
Authorization: `Bearer ${this.help_scout.$auth.oauth_access_token}`,
},
})
},
})
Sync Customer Support Data with CRM: When a new conversation is created or updated in Help Scout, trigger a workflow that adds or updates the customer details in a CRM like Salesforce, keeping both systems in sync.
Automate Customer Support Follow-ups: After a conversation is marked as resolved in Help Scout, launch a Pipedream workflow that automatically sends a follow-up email after a specific period to gather feedback or offer further assistance.
Real-Time Support Analytics Dashboard: Use Pipedream to collect data from Help Scout on conversation statuses, response times, and customer satisfaction. Then, push this data to a dashboard service like Google Sheets or Geckoboard to create a real-time analytics display for your support team.
Help Scout uses OAuth authentication. When you connect your Help Scout account, Pipedream will open a popup window where you can sign into Help Scout and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Help Scout API.
Pipedream requests the following authorization scopes when you connect your account:
GET
https://secure.helpscout.net/authentication/authorizeClientApplication
?
client_id={{oauth.client_id}}
&
redirect_uri={{oauth.redirect_uri}}
&
state={{oauth.state}}
&
response_type=code
&
scope={{oauth.space_separated_scopes}}
POST
https://api.helpscout.net/v2/oauth2/token
content-type: application/x-www-form-urlencoded
accept: application/json
client_id={{oauth.client_id}}
&
client_secret={{oauth.client_secret}}
&
redirect_uri={{oauth.redirect_uri}}
&
grant_type=authorization_code
&
code={{oauth.code}}
POST
https://api.helpscout.net/v2/oauth2/token
content-type: application/x-www-form-urlencoded
accept: application/json
client_id={{oauth.client_id}}
&
client_secret={{oauth.client_secret}}
&
grant_type=refresh_token
&
refresh_token={{oauth.refresh_token}}