List Articles with Help Scout (API Keys) API

Pipedream makes it easy to connect APIs for Help Scout (API Keys) and 3,000+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

List Articles with the Help Scout (API Keys) API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to List Articles with the Help Scout (API Keys) API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the List Articles action
1. Connect your Help Scout (API Keys) account
2. Select a Collection ID
3. Optional- Select a Category ID
4. Optional- Select a Status
5. Optional- Select a Sort
6. Optional- Select a Order
7. Optional- Configure Page
8. Optional- Configure Page Size
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

List Articles on Help Scout (API Keys)

Description:Retrieve a list of articles by collection or category. [See the documentation](https://developer.helpscout.com/docs-api/articles/list/)

Version:0.0.1

Key:help_scout_api_keys-list-articles

View on GitHub

Code#

import helpscout from "../../help_scout_api_keys.app.mjs";

export default {
  key: "help_scout_api_keys-list-articles",
  name: "List Articles",
  description: "Retrieve a list of articles by collection or category. [See the documentation](https://developer.helpscout.com/docs-api/articles/list/)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  props: {
    helpscout,
    collectionId: {
      propDefinition: [
        helpscout,
        "collectionId",
      ],
    },
    categoryId: {
      propDefinition: [
        helpscout,
        "categoryId",
        ({ collectionId }) => ({
          collectionId,
        }),
      ],
      optional: true,
    },
    status: {
      propDefinition: [
        helpscout,
        "status",
      ],
    },
    sort: {
      type: "string",
      label: "Sort",
      description: "The field to sort the articles by",
      options: [
        "number",
        "status",
        "name",
        "popularity",
        "createdAt",
        "updatedAt",
      ],
      optional: true,
    },
    order: {
      type: "string",
      label: "Order",
      description: "The order to sort the articles by",
      options: [
        "asc",
        "desc",
      ],
      optional: true,
    },
    page: {
      propDefinition: [
        helpscout,
        "page",
      ],
    },
    pageSize: {
      type: "integer",
      label: "Page Size",
      description: "The number of articles to retrieve per page",
      optional: true,
      default: 100,
      max: 100,
    },
  },
  async run({ $ }) {
    const params = {
      status: this.status,
      sort: this.sort,
      order: this.order,
      page: this.page,
      pageSize: this.pageSize,
    };
    const response = this.categoryId
      ? await this.helpscout.listArticlesByCategory({
        $,
        categoryId: this.categoryId,
        params,
      })
      : await this.helpscout.listArticlesByCollection({
        $,
        collectionId: this.collectionId,
        params,
      });
    $.export("$summary", `Retrieved ${response.articles.items.length} article${response.articles.items.length === 1
      ? ""
      : "s"}.`);
    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Help Scout (API Keys)	`helpscout`	`app`	This component uses the Help Scout (API Keys) app.
Collection ID	`collectionId`	`string`	Select a value from the drop down menu.
Category ID	`categoryId`	`string`	Select a value from the drop down menu.
Status	`status`	`string`	Select a value from the drop down menu:`allpublishednotpublished`
Sort	`sort`	`string`	Select a value from the drop down menu:`numberstatusnamepopularitycreatedAtupdatedAt`
Order	`order`	`string`	Select a value from the drop down menu:`ascdesc`
Page	`page`	`integer`	The page number to retrieve
Page Size	`pageSize`	`integer`	The number of articles to retrieve per page