Help Scout

Create conversations, list conversations, and add replies in Help Scout. In Appbricx, your workflows and server functions call it by name once it is connected.

Connect Help ScoutFull reference

What you can do

9 actions, each one call from a workflow or a server function. Triggers come from your app: a row changing, a schedule or a webhook.

  • Create Conversationcreate_conversation
    Start a new conversation.
  • Find Conversationfind_conversation
    Finds an existing conversation using provided filter.
  • Send Replysend_reply
    Sends a reply in an existing conversation.
  • Add Noteadd_note
    Adds a note to a conversation.
  • Create Customercreate_customer
    Adds a new customer to Help Scout.
  • Find Customerfind_customer
    Finds a customer by email.
  • Find Userfind_user
    Finds a user by email.
  • Update Customer Propertiesupdate_customer_properties
    Updates customer's properties.
  • Custom API Callcustom_api_call
    Make a custom API call to a specific endpoint

Set it up

About two minutes, once per project or once for the whole workspace.

  1. Open Integrations in the builder

    Backend panel, Integrations tab, then Help Scout. To connect it for every project, use Workspace settings, Integrations.

  2. Add your credentials

    An API key (or token) from your Help Scout account, pasted once. It is stored encrypted and only read on the server when an action runs.

    • API key From Help Scout's settings
  3. Call an action

    From a workflow, by integration id and action name. The call answers with success, output and, when it fails, the reason.

    Workflow
    // .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("help-scout", "create_conversation", {
    "mailboxId": "<mailboxId>",
    "subject": "<subject>",
    "customerEmail": "<customer email>",
    "threadType": "chat",
    "status": "active",
    "body": "<body>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("Help Scout answered", { output: res.output });
}

Help Scout and its logo are trademarks of their owner, shown only to identify the service this integration connects to. Their use does not imply endorsement by, or affiliation with, that company.

Connect Help Scout once. Every workflow can use it.

Start freeAll integrations