List Articles with HelpDocs API on New Submission (Instant) from Jotform API

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

Trigger workflow on

New Submission (Instant) from the Jotform 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 Jotform 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 Submission (Instant) trigger
1. Connect your Jotform account
2. Optional- Select a Team
3. Select a Form
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 Submission (Instant) on Jotform

Description:Emit new event when a form is submitted

Version:0.1.6

Key:jotform-new-submission

View on GitHub

Jotform Overview#

Jotform’s API is a powerhouse for automating form and survey data management. With Pipedream, harness this API to trigger workflows from new form submissions, manipulate and analyze your form data, and sync it across various platforms. Think streamlined data entry to CRMs, instant notifications for new leads or feedback, and timely data backups to cloud storage.

Trigger Code#

import jotform from "../../jotform.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "jotform-new-submission",
  name: "New Submission (Instant)",
  description: "Emit new event when a form is submitted",
  version: "0.1.6",
  type: "source",
  dedupe: "unique",
  props: {
    jotform,
    http: "$.interface.http",
    teamId: {
      propDefinition: [
        jotform,
        "teamId",
      ],
    },
    formId: {
      propDefinition: [
        jotform,
        "formId",
        (c) => ({
          teamId: c.teamId,
          excludeDeleted: true,
        }),
      ],
    },
  },
  hooks: {
    async deploy() {
      const { content: form } = await this.jotform.getForm(this.formId, this.teamId);
      const { content: submissions } = await this.jotform.getFormSubmissions({
        formId: this.formId,
        teamId: this.teamId,
        params: {
          limit: 25,
          orderby: "created_at",
        },
      });
      for (let submission of submissions.reverse()) {
        const meta = {
          id: submission.id,
          summary: form.title,
          ts: Date.now(),
        };
        this.$emit(submission, meta);
      }
    },
    async activate() {
      return (await this.jotform.createHook({
        endpoint: this.http.endpoint,
        formId: this.formId,
        teamId: this.teamId,
      }));
    },
    async deactivate() {
      return (await this.jotform.deleteHook({
        endpoint: this.http.endpoint,
        formId: this.formId,
        teamId: this.teamId,
      }));
    },
  },
  async run(event) {
    const { body } = event;
    let { content: submission } = await this.jotform.getFormSubmission({
      submissionId: body.submissionID,
      teamId: this.teamId,
    });

    // insert answers from the webhook event
    const rawRequest = JSON.parse(body.rawRequest);
    for (const key of Object.keys(rawRequest)) {
      const regex = /^q(\d+)_/;
      const match = key.match(regex);
      if (match && match[1]) {
        submission.answers[match[1]].answer = rawRequest[key];
      }
    }

    this.$emit(submission, {
      summary: body.formTitle || JSON.stringify(body),
      id: body.submissionID,
      ts: Date.now(),
    });
  },
  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
Jotform	`jotform`	`app`	This component uses the Jotform app.
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.
Team	`teamId`	`string`	Select a value from the drop down menu.
Form	`formId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

About Jotform#

Jotform enables you to create online forms, collect responses directly in your email, and create fillable PDF forms.

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.1

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.1",
  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 Submission (Instant) from Jotform API

Jotform + HelpDocs

Try it

Get Category with HelpDocs API on New Submission (Instant) from Jotform API

Jotform + HelpDocs

Try it

Create Article with HelpDocs API on New Submission (Instant) from Jotform API

Jotform + HelpDocs

Try it

List Categories with HelpDocs API on New Submission (Instant) from Jotform API

Jotform + HelpDocs

Try it

Popular Triggers#

New Submission (Instant) from the Jotform API

Emit new event when a form is submitted

Try it

Popular Actions#

Get Form Submissions with the Jotform API

Gets a list of form responses See the docs here

Try it

Get Monthly User Usage with the Jotform API

Gets number of form submissions received this month. Also, get number of SSL form submissions, payment form submissions and upload space used by user See the docs here

Try it

Get User Submissions with the Jotform API

Gets a list of all submissions for all forms on the account See the docs here

Try it

Create Article with the HelpDocs API

Create a new article in your HelpDocs knowledge base. See the documentation

Try it

Create Category with the HelpDocs API

Create a new category in your HelpDocs knowledge base to organize articles. See the documentation

Try it