Skip to content

Help Scout ​

Overdesk connects to Help Scout in one click: an admin approves Overdesk in Help Scout. If you would rather connect through an app you create in your own Help Scout account, that works too. Either way, Overdesk reads your mailboxes, learns from your past conversations and saved replies, and places each draft on the conversation as an internal note or as an unsent draft reply in the composer. For the overview of Overdesk with Help Scout, see the Help Scout page on overdesk.io.

Connect Help Scout ​

You need to be an owner or admin in Overdesk.

  1. In Overdesk, open Integrations and choose Help Scout.
  2. Choose Connect with Help Scout. Help Scout opens and asks you to approve Overdesk.
  3. Approve it. You come back to the Help Scout page in Overdesk, which lists the mailboxes Overdesk can read.

Approve as the person replies should come from. Overdesk works through that person's Help Scout account: it sees the mailboxes they can see, and the drafts, notes and replies it adds appear under their name. Help Scout also has to let that person use its API. If it does not, Overdesk says so, and a Help Scout administrator can turn on "Access API" for them under Manage, then Users, their name, then Permissions. Then connect again.

Use your own Help Scout app instead ​

To connect through an app in your own Help Scout account, open Use your own Help Scout app instead on the same page.

  1. In Help Scout, open your profile menu and choose My Apps, then Create My App.
  2. Pick OAuth2 with Client Credentials.
  3. Help Scout also asks for a Redirection URL. Overdesk never uses it, because Client Credentials apps do not redirect, but the field is required, so enter https://app.overdesk.io.
  4. Create the app and copy its App ID and App Secret.
  5. Paste them into App ID and App Secret in Overdesk.
  6. Choose Connect.

Use My Apps under your profile, not Manage then Apps. That second page is the Apps Directory, and the app it creates asks for a Content URL and a content signature key instead of giving you an App ID and Secret, so it cannot connect Overdesk.

Internal notes from Overdesk then appear under the Help Scout user who created the app, so create it from an account your team recognises.

Switch to one-click connect ​

A workspace connected through its own app sees Switch to one-click connect on the Help Scout page. Approving there replaces the app in place, so your knowledge base, Docs API key and settings stay as they are. Approve from the same Help Scout account and @Overdesk in notes stays on too. Drafts, notes and replies from then on appear under the name of the person who approved.

Reconnect Help Scout ​

A workspace connected in one click sees Reconnect Help Scout on the same page. Approve there again if Help Scout stops working, for example after the person who approved Overdesk leaves or loses "Access API". The new approval replaces the old one in place, so your knowledge base and settings stay as they are, which disconnecting would not do.

Add your Help Scout Docs articles ​

If you publish articles with Help Scout Docs, Overdesk can pull them into your knowledge base so drafts cite them. This takes a separate Docs API key.

  1. In Help Scout, open your profile, then Security and Access, and find the Docs API section.
  2. Copy the Docs API key.
  3. Paste it into Docs API key (optional) when you connect, or later with Add Docs API key under Help docs on the Help Scout page in Overdesk.

Sync help desk docs then imports your published articles every night at 04:30.

Where drafts appear ​

Drafts arrive as internal notes by default. Help Scout can also hold an unsent draft reply in the composer, ready to edit and send: choose Draft reply, ready to edit and send under Guardrails → Send mode. A draft reply needs the customer's email address on the conversation; a conversation without one gets a note instead.

Help Scout is also where editing a draft in Overdesk reaches furthest. When you Edit or Discard a draft reply from its page in Overdesk, the copy in the composer changes with it, as long as nobody has already rewritten it there.

Sending replies ​

Once your workspace turns sending on, Overdesk sends the replies your guardrails approve on email conversations. A chat or phone conversation waits for your team. After a reply the conversation is set to Pending, so it waits for the customer. Under After Overdesk sends a reply you can choose Active, Closed or Leave as is instead. A reply that hands the conversation to a teammate leaves it Active, whatever you chose. Before Overdesk sends a reply on its own, it checks everyone in the conversation's CC and BCC against Excluded senders, your rules' customer lists and the people you erased, and a reply that would reach one of them waits for your team (see Sending replies).

Inboxes and escalation ​

In Allowed inboxes, enter all or list the mailbox numbers to draft in. A mailbox's number is in the address bar when you open it in Help Scout.

Escalation rules can hand a conversation to a Help Scout user or team, picked from a list Overdesk reads from your account. See Escalation.

Real-time updates ​

Help Scout makes you invent a webhook's signing secret, so Overdesk generates one for you. The steps are in Real-time updates with webhooks.

If the connection is refused ​

With one-click connect, the page you come back to says what went wrong.

  • "Help Scout says the person who approved Overdesk is not allowed to use its API" means that person needs "Access API" in Help Scout, as described under Connect Help Scout.
  • "This approval took too long, or was started somewhere else" means the approval was finished in a different browser from the one that started it, or long after. Start again from the Help Scout page, in one browser.
  • "Help Scout was not connected" means the approval was declined, and nothing was saved.
  • "Your plan has no room for another help desk" means another help desk was connected while you were approving. Disconnect one or change your plan, then connect Help Scout again.

With your own app, the form shows Help Scout's own reason when it refuses what you typed.

  • A message starting "credentials rejected by Help Scout" means the App ID or App Secret did not work, and Help Scout's own words follow it. Check that both come from a My Apps app, not an Apps Directory app.
  • "Help Scout rejected the Docs API key" means the optional key is not a Docs API key. Copy it from the Docs API section of your profile, not the App Secret.

Disconnecting Help Scout deletes its credentials and everything it put into your knowledge base, and removes the webhook that @Overdesk in notes added to your Help Scout.