Create Article with HelpDocs API on New Requests (Payload Only) from HTTP / Webhook API

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

Trigger workflow on

New Requests (Payload Only) from the HTTP / Webhook API

Next, do this

Create Article 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 HTTP / Webhook 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 Requests (Payload Only) trigger
1. Connect your HTTP / Webhook account
Configure the Create Article action
1. Connect your HelpDocs account
2. Configure Title
3. Optional- Select a Category ID
4. Optional- Configure Body
5. Optional- Configure Is Private
6. Optional- Configure Is Published
7. Optional- Configure Description
8. Optional- Configure Short Version
9. Optional- Configure Slug
10. Optional- Configure Tags
11. Optional- Configure Multilingual
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 Requests (Payload Only) on HTTP / Webhook

Description:Get a URL and emit the HTTP body as an event on every request

Version:0.1.1

Key:http-new-requests-payload-only

View on GitHub

HTTP / Webhook Overview#

Build, test, and send HTTP requests without code using your Pipedream workflows. The HTTP / Webhook action is a tool to build HTTP requests with a Postman-like graphical interface.

Point and click HTTP requests

Define the target URL, HTTP verb, headers, query parameters, and payload body without writing custom code.

$A screenshot of Pipedream's HTTP Request Configuration interface with a GET request type selected. The request URL is set to 'https://api.openai.com/v1/models'. The 'Auth' tab is highlighted, indicating that authentication is required for this request. In the headers section, there are two headers configured: 'User-Agent' is set to 'pipedream/1', and 'Authorization' is set to 'Bearer {{openai_api_key}}', showing how the OpenAI account's API key is dynamically inserted into the headers to handle authentication automatically.$

Here's an example workflow that uses the HTTP / Webhook action to send an authenticated API request to OpenAI.

Focus on integrating, not authenticating

This action can also use your connected accounts with third-party APIs. Selecting an integrated app will automatically update the request’s headers to authenticate with the app properly, and even inject your token dynamically.

Pipedream integrates with thousands of APIs, but if you can’t find a Pipedream integration simply use Environment Variables in your request headers to authenticate with.

Compatible with no code actions or Node.js and Python

The HTTP/Webhook action exports HTTP response data for use in subsequent workflow steps, enabling easy data transformation, further API calls, database storage, and more.

Response data is available for both coded (Node.js, Python) and no-code steps within your workflow.

Trigger Code#

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

// Core HTTP component
// Returns a 200 OK response, emits the HTTP payload as an event
export default {
  key: "http-new-requests-payload-only",
  name: "New Requests (Payload Only)",
  // eslint-disable-next-line
  description: "Get a URL and emit the HTTP body as an event on every request",
  version: "0.1.1",
  type: "source",
  props: {
    // eslint-disable-next-line
    httpInterface: {
      type: "$.interface.http",
      customResponse: true,
    },
    http,
  },
  async run(event) {
    const { body } = event;
    this.httpInterface.respond({
      status: 200,
      body,
    });
    // Emit the HTTP payload
    this.$emit({
      body,
    });
  },
};

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
N/A	`httpInterface`	`$.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.
HTTP / Webhook	`http`	`app`	This component uses the HTTP / Webhook app.

Trigger Authentication#

The HTTP / Webhook API does not require authentication.

About HTTP / Webhook#

Get a unique URL where you can send HTTP or webhook requests

Action#

Create Article on HelpDocs

Description:Create a new article in your HelpDocs knowledge base. [See the documentation](https://apidocs.helpdocs.io/article/8Y2t6NVxeU-creating-an-article)

Version:0.0.2

Key:helpdocs-create-article

View on GitHub

Action Code#

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

export default {
  key: "helpdocs-create-article",
  name: "Create Article",
  description: "Create a new article in your HelpDocs knowledge base. [See the documentation](https://apidocs.helpdocs.io/article/8Y2t6NVxeU-creating-an-article)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    helpdocs,
    title: {
      type: "string",
      label: "Title",
      description: "The title of the article",
    },
    categoryId: {
      propDefinition: [
        helpdocs,
        "categoryId",
      ],
      optional: true,
    },
    body: {
      type: "string",
      label: "Body",
      description: "The body of the article",
      optional: true,
    },
    isPrivate: {
      type: "boolean",
      label: "Is Private",
      description: "Whether the article is private",
      optional: true,
    },
    isPublished: {
      type: "boolean",
      label: "Is Published",
      description: "Whether the article is published",
      optional: true,
    },
    description: {
      type: "string",
      label: "Description",
      description: "The description of the article",
      optional: true,
    },
    shortVersion: {
      type: "string",
      label: "Short Version",
      description: "The short version of the article",
      optional: true,
    },
    slug: {
      type: "string",
      label: "Slug",
      description: "The slug of the article",
      optional: true,
    },
    tags: {
      type: "string[]",
      label: "Tags",
      description: "The tags of the article",
      optional: true,
    },
    multilingual: {
      type: "string[]",
      label: "Multilingual",
      description: "The language code(s) of the article (e.g. `en`, `fr`, etc.)",
      optional: true,
    },
  },
  async run({ $ }) {
    const { article } = await this.helpdocs.createArticle({
      $,
      data: {
        title: this.title,
        category_id: this.categoryId,
        body: this.body,
        is_private: this.isPrivate,
        is_published: this.isPublished,
        description: this.description,
        short_version: this.shortVersion,
        slug: this.slug,
        tags: this.tags,
        multilingual: this.multilingual,
      },
    });

    $.export("$summary", `Created article ${this.title}`);
    return article;
  },
};

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.
Title	`title`	`string`	The title of the article
Category ID	`categoryId`	`string`	Select a value from the drop down menu.
Body	`body`	`string`	The body of the article
Is Private	`isPrivate`	`boolean`	Whether the article is private
Is Published	`isPublished`	`boolean`	Whether the article is published
Description	`description`	`string`	The description of the article
Short Version	`shortVersion`	`string`	The short version of the article
Slug	`slug`	`string`	The slug of the article
Tags	`tags`	`string[]`	The tags of the article
Multilingual	`multilingual`	`string[]`	The language code(s) of the article (e.g. `en`, `fr`, etc.)

Action Authentication#

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

About HelpDocs#

The Documentation Engine Behind AI-Driven Support

More Ways to Connect HelpDocs + HTTP / Webhook#

Other Popular Integrations#

Create Article with HelpDocs API on New Requests from HTTP / Webhook API

HTTP / Webhook + HelpDocs

Try it

Create Category with HelpDocs API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + HelpDocs

Try it

Create Category with HelpDocs API on New Requests from HTTP / Webhook API

HTTP / Webhook + HelpDocs

Try it

Delete Article with HelpDocs API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + HelpDocs

Try it

Delete Article with HelpDocs API on New Requests from HTTP / Webhook API

HTTP / Webhook + HelpDocs

Try it

Popular Triggers#

New Requests from the HTTP / Webhook API

Get a URL and emit the full HTTP event on every request (including headers and query parameters). You can also configure the HTTP response code, body, and more.

Try it

New Requests (Payload Only) from the HTTP / Webhook API

Get a URL and emit the HTTP body as an event on every request

Try it

New event when the content of the URL changes. from the HTTP / Webhook API

Emit new event when the content of the URL changes.

Try it