What can you build with the Help Scout API?
Help Scout is a customer service platform that enables companies to deliver great customer service. With the Help Scout API, you can extend the functionality of Help Scout in a variety of ways.
Here are a few examples of what you can build with the Help Scout API:
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 ${auths.helpscout.oauth_access_token}`,
},
})
},
})
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}}