List Articles with HelpDocs API on New Scheduled Tasks from Pipedream API

Pipedream makes it easy to connect APIs for HelpDocs, Pipedream and 2,900+ other apps remarkably fast.

Trigger workflow on

New Scheduled Tasks from the Pipedream API

Next, do this

List Articles with the HelpDocs 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#

This integration creates a workflow with a Pipedream trigger and HelpDocs action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Scheduled Tasks trigger
1. Connect your Pipedream account
2. Optional- Configure Secret
Configure the List Articles action
1. Connect your HelpDocs account
2. Optional- Select a Category ID
3. Optional- Configure Tag
4. Optional- Configure Include Body
5. Optional- Select a Group ID
6. Optional- Select a Status
7. Optional- Configure Is Stale
8. Optional- Configure Needs Translation
9. Optional- Configure Language Code
10. Optional- Configure Updated At Before
11. Optional- Configure Updated At After
12. Optional- Configure Working Copy
13. Optional- Configure Max Results
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

New Scheduled Tasks on Pipedream

Description:Exposes an HTTP API for scheduling messages to be emitted at a future time

Version:0.3.1

Key:pipedream-new-scheduled-tasks

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Trigger Code#

import pipedream from "../../pipedream.app.mjs";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";

export default {
  key: "pipedream-new-scheduled-tasks",
  name: "New Scheduled Tasks",
  type: "source",
  description:
    "Exposes an HTTP API for scheduling messages to be emitted at a future time",
  version: "0.3.1",
  dedupe: "unique", // Dedupe on a UUID generated for every scheduled task
  props: {
    pipedream,
    secret: {
      type: "string",
      secret: true,
      label: "Secret",
      optional: true,
      description:
        "**Optional but recommended**: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests",
    },
    http: {
      label: "Endpoint",
      description: "The endpoint where you'll send task scheduler requests",
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
  },
  methods: {
    // To schedule future emits, we emit to the selfChannel of the component
    selfChannel() {
      return "self";
    },
    // Queue for future emits that haven't yet been delivered
    queuedEventsChannel() {
      return "$in";
    },
    httpRespond({
      status, body,
    }) {
      this.http.respond({
        headers: {
          "content-type": "application/json",
        },
        status,
        body,
      });
    },
    async selfSubscribe() {
      // Subscribe the component to itself. We do this here because even in
      // the activate hook, the component isn't available to take subscriptions.
      // Scheduled tasks are sent to the self channel, which emits the message at
      // the specified delivery_ts to this component.
      const isSubscribedToSelf = this.db.get("isSubscribedToSelf");
      if (!isSubscribedToSelf) {
        const componentId = process.env.PD_COMPONENT;
        const selfChannel = this.selfChannel();
        console.log(`Subscribing to ${selfChannel} channel for event source`);
        console.log(
          await this.pipedream.subscribe(componentId, componentId, selfChannel),
        );
        this.db.set("isSubscribedToSelf", true);
      }
    },
    validateEventBody(event, operation) {
      const errors = [];

      // Secrets are optional, so we first check if the user configured
      // a secret, then check its value against the prop (validation below)
      if (this.secret && event.headers["x-pd-secret"] !== this.secret) {
        errors.push(
          "Secret on incoming request doesn't match the configured secret",
        );
      }

      if (operation === "schedule") {
        const {
          timestamp,
          message,
        } = event.body;
        // timestamp should be an ISO 8601 string. Parse and check for validity below.
        const epoch = Date.parse(timestamp);

        if (!timestamp) {
          errors.push(
            "No timestamp included in payload. Please provide an ISO8601 timestamp in the 'timestamp' field",
          );
        }
        if (timestamp && !epoch) {
          errors.push("Timestamp isn't a valid ISO 8601 string");
        }
        if (!message) {
          errors.push("No message passed in payload");
        }
      }

      return errors;
    },
    scheduleTask(event) {
      const errors = this.validateEventBody(event, "schedule");
      let status, body;

      if (errors.length) {
        console.log(errors);
        status = 400;
        body = {
          errors,
        };
      } else {
        const id = this.emitScheduleEvent(event.body, event.body.timestamp);
        status = 200;
        body = {
          msg: "Successfully scheduled task",
          id,
        };
      }

      this.httpRespond({
        status,
        body,
      });
    },
    emitScheduleEvent(event, timestamp) {
      const selfChannel = this.selfChannel();
      const epoch = Date.parse(timestamp);
      const $id = uuid();

      console.log(`Scheduled event to emit on: ${new Date(epoch)}`);

      this.$emit(
        {
          ...event,
          $channel: selfChannel,
          $id,
        },
        {
          name: selfChannel,
          id: $id,
          delivery_ts: epoch,
        },
      );

      return $id;
    },
    async cancelTask(event) {
      const errors = this.validateEventBody(event, "cancel");
      let status, msg;

      if (errors.length) {
        console.log(errors);
        status = 400;
        msg = "Secret on incoming request doesn't match the configured secret";
      } else {
        try {
          const id = event.body.id;
          const isCanceled = await this.deleteEvent(event);
          if (isCanceled) {
            status = 200;
            msg = `Cancelled scheduled task for event ${id}`;
          } else {
            status = 404;
            msg = `No event with ${id} found`;
          }
        } catch (error) {
          console.log(error);
          status = 500;
          msg = "Failed to schedule task. Please see the logs";
        }
      }

      this.httpRespond({
        status,
        body: {
          msg,
        },
      });
    },
    async deleteEvent(event) {
      const componentId = process.env.PD_COMPONENT;
      const inChannel = this.queuedEventsChannel();

      // The user must pass a scheduled event UUID they'd like to cancel
      // We lookup the event by ID and delete it
      const { id } = event.body;

      // List events in the $in channel - the queue of scheduled events, to be emitted in the future
      const events = await this.pipedream.listEvents(
        componentId,
        inChannel,
      );
      console.log("Events: ", events);

      // Find the event in the list by id
      const eventToCancel = events.data.find((e) => {
        const { metadata } = e;
        return metadata.id === id;
      });

      console.log("Event to cancel: ", eventToCancel);

      if (!eventToCancel) {
        console.log(`No event with ${id} found`);
        return false;
      }

      // Delete the event
      await this.pipedream.deleteEvent(
        componentId,
        eventToCancel.id,
        inChannel,
      );
      return true;
    },
    emitEvent(event, summary) {
      // Delete the channel name and id from the incoming event, which were used only as metadata
      const id = event.$id;
      delete event.$channel;
      delete event.$id;

      this.$emit(event, {
        summary: summary ?? JSON.stringify(event),
        id,
        ts: +new Date(),
      });
    },
  },
  async run(event) {
    await this.selfSubscribe();

    const { path } = event;
    if (path === "/schedule") {
      this.scheduleTask(event);
    } else if (path === "/cancel") {
      await this.cancelTask(event);
    } else if (event.$channel === this.selfChannel()) {
      this.emitEvent(event);
    }
  },
  sampleEmit,
};

Trigger 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
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Secret	`secret`	`string`	Optional but recommended: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

Pipedream uses API keys for authentication. When you connect your Pipedream account, Pipedream securely stores the keys so you can easily authenticate to Pipedream APIs in both code and no-code steps.

About Pipedream#

Integration platform for developers

Action#

List Articles on HelpDocs

Description:Retrieve a list of articles from your HelpDocs knowledge base. [See the documentation](https://apidocs.helpdocs.io/article/OqvaxRMHgN-getting-articles)

Version:0.0.2

Key:helpdocs-list-articles

View on GitHub

Action Code#

import helpdocs from "../../helpdocs.app.mjs";

export default {
  key: "helpdocs-list-articles",
  name: "List Articles",
  description: "Retrieve a list of articles from your HelpDocs knowledge base. [See the documentation](https://apidocs.helpdocs.io/article/OqvaxRMHgN-getting-articles)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  type: "action",
  props: {
    helpdocs,
    categoryId: {
      propDefinition: [
        helpdocs,
        "categoryId",
      ],
      optional: true,
    },
    tag: {
      type: "string",
      label: "Tag",
      description: "Filter articles by tag",
      optional: true,
    },
    includeBody: {
      type: "boolean",
      label: "Include Body",
      description: "Include the HTML `body` field of each article",
      optional: true,
    },
    permissionGroupId: {
      propDefinition: [
        helpdocs,
        "groupId",
      ],
      optional: true,
    },
    status: {
      type: "string",
      label: "Status",
      description: "Filter articles by status",
      options: [
        "published",
        "draft",
        "private",
      ],
      optional: true,
    },
    isStale: {
      type: "boolean",
      label: "Is Stale",
      description: "Restrict returned articles based on whether they are set as Stale or not",
      optional: true,
    },
    needsTranslation: {
      type: "boolean",
      label: "Needs Translation",
      description: "Restrict returned articles base on whether it's marked as Needs Translation",
      optional: true,
    },
    languageCode: {
      type: "string",
      label: "Language Code",
      description: "Restrict returned articles based on language code (e.g. `en`, `fr`, etc.)",
      optional: true,
    },
    updatedAtBefore: {
      type: "string",
      label: "Updated At Before",
      description: "Restrict returned articles based on whether they were published before a certain date. E.g. `2025-01-01`",
      optional: true,
    },
    updatedAtAfter: {
      type: "string",
      label: "Updated At After",
      description: "Restrict returned articles based on whether they were published after a certain date. E.g. `2025-01-01`",
      optional: true,
    },
    workingCopy: {
      type: "boolean",
      label: "Working Copy",
      description: "Returns the latest rather than currently published versions",
      optional: true,
    },
    maxResults: {
      type: "integer",
      label: "Max Results",
      description: "The maximum number of articles to return",
      default: 100,
      optional: true,
    },
  },
  async run({ $ }) {
    const results = this.helpdocs.paginate({
      fn: this.helpdocs.listArticles,
      params: {
        category_id: this.categoryId,
        tag: this.tag,
        include_body: this.includeBody,
        permission_group_id: this.permissionGroupId,
        status: this.status,
        is_stale: this.isStale,
        needs_translation: this.needsTranslation,
        language_code: this.languageCode,
        updated_at_before: this.updatedAtBefore,
        updated_at_after: this.updatedAtAfter,
        working_copy: this.workingCopy,
      },
      resourceKey: "articles",
      max: this.maxResults,
    });

    const articles = [];
    for await (const article of results) {
      articles.push(article);
    }

    $.export("$summary", `Found ${articles.length} articles`);
    return articles;
  },
};

Action Configuration#

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

Label	Prop	Type	Description
HelpDocs	`helpdocs`	`app`	This component uses the HelpDocs app.
Category ID	`categoryId`	`string`	Select a value from the drop down menu.
Tag	`tag`	`string`	Filter articles by tag
Include Body	`includeBody`	`boolean`	Include the HTML `body` field of each article
Group ID	`permissionGroupId`	`string`	Select a value from the drop down menu.
Status	`status`	`string`	Select a value from the drop down menu:`publisheddraftprivate`
Is Stale	`isStale`	`boolean`	Restrict returned articles based on whether they are set as Stale or not
Needs Translation	`needsTranslation`	`boolean`	Restrict returned articles base on whether it's marked as Needs Translation
Language Code	`languageCode`	`string`	Restrict returned articles based on language code (e.g. `en`, `fr`, etc.)
Updated At Before	`updatedAtBefore`	`string`	Restrict returned articles based on whether they were published before a certain date. E.g. `2025-01-01`
Updated At After	`updatedAtAfter`	`string`	Restrict returned articles based on whether they were published after a certain date. E.g. `2025-01-01`
Working Copy	`workingCopy`	`boolean`	Returns the latest rather than currently published versions
Max Results	`maxResults`	`integer`	The maximum number of articles to return

Try it

Create Category with HelpDocs API on New Scheduled Tasks from Pipedream API

Pipedream + HelpDocs

Try it

Create Article with HelpDocs API on New Scheduled Tasks from Pipedream API

Pipedream + HelpDocs

Try it

Delete Category with HelpDocs API on New Scheduled Tasks from Pipedream API

Pipedream + HelpDocs

Try it

Generate Chatbot Source Page with HelpDocs API on New Scheduled Tasks from Pipedream API

Pipedream + HelpDocs

Try it

Popular Triggers#

New Scheduled Tasks from the Pipedream API

Exposes an HTTP API for scheduling messages to be emitted at a future time

Try it

Card Due Date Reminder from the Pipedream API

Emit new event at a specified time before a card is due.

Try it

New Upcoming Calendar Event from the Pipedream API

Emit new event when a Calendar event is upcoming, this source is using reminderMinutesBeforeStart property of the event to determine the time it should emit.

Try it