Create Page with Documenterra API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Page with the Documenterra 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 Create Page with the Documenterra API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Create Page action
1. Connect your Documenterra account
2. Select a Project Identity
3. Configure Page ID
4. Configure Assignee User Name
5. Configure Owner User Name
6. Select a Status Name
7. Optional- Configure Page Title
8. Optional- Configure Body HTML
9. Optional- Configure Index Keywords
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

Integrations#

Create Page with Documenterra API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Documenterra

Try it

Create Page with Documenterra API on New Submission from Typeform API

Typeform + Documenterra

Try it

Create Page with Documenterra API on New Submission (Instant) from Jotform API

Jotform + Documenterra

Try it

Create Page with Documenterra API on New Scheduled Tasks from Pipedream API

Pipedream + Documenterra

Try it

Create Page with Documenterra API on npm Download Counts from npm API

npm + Documenterra

Try it

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.

Create Page on Documenterra

Description:Creates a new page. [See the documentation](https://documenterra.ru/docs/user-manual/api-sozdaniye-stranitsy.html)

Version:0.0.1

Key:documenterra-create-page

View on GitHub

Code#

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

export default {
  key: "documenterra-create-page",
  name: "Create Page",
  description: "Creates a new page. [See the documentation](https://documenterra.ru/docs/user-manual/api-sozdaniye-stranitsy.html)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    projectId: {
      propDefinition: [
        app,
        "projectId",
      ],
    },
    id: {
      type: "string",
      label: "Page ID",
      description: "The unique identifier for the page.",
    },
    assigneeUserName: {
      type: "string",
      label: "Assignee User Name",
      description: "Login of the artist to whom the page is assigned.",
    },
    ownerUserName: {
      type: "string",
      label: "Owner User Name",
      description: "The name of the user who is the owner of the page.",
    },
    statusName: {
      type: "string",
      label: "Status Name",
      description: "Page workflow status.",
      options: [
        "Ready",
        "Draft",
        "Under Review",
      ],
    },
    title: {
      type: "string",
      label: "Page Title",
      description: "The title of the page.",
      optional: true,
    },
    bodyHtml: {
      type: "string",
      label: "Body HTML",
      description: "HTML content of the page.",
      optional: true,
    },
    indexKeywords: {
      type: "string[]",
      label: "Index Keywords",
      description: "An array of strings containing keywords to be used when creating the page.",
      optional: true,
    },
  },
  methods: {
    createPage({
      projectId, ...args
    } = {}) {
      return this.app.post({
        path: `/projects/${projectId}/articles`,
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      createPage,
      projectId,
      assigneeUserName,
      id,
      ownerUserName,
      statusName,
      title,
      bodyHtml,
      indexKeywords,
    } = this;

    const response = await createPage({
      $,
      projectId,
      data: {
        assigneeUserName,
        id,
        ownerUserName,
        statusName,
        title,
        bodyHtml,
        indexKeywords,
      },
    });

    $.export("$summary", `Successfully created a new page with ID: \`${response?.id}\`.`);
    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
Documenterra	`app`	`app`	This component uses the Documenterra app.
Project Identity	`projectId`	`string`	Select a value from the drop down menu.
Page ID	`id`	`string`	The unique identifier for the page.
Assignee User Name	`assigneeUserName`	`string`	Login of the artist to whom the page is assigned.
Owner User Name	`ownerUserName`	`string`	The name of the user who is the owner of the page.
Status Name	`statusName`	`string`	Select a value from the drop down menu:`ReadyDraftUnder Review`
Page Title	`title`	`string`	The title of the page.
Body HTML	`bodyHtml`	`string`	HTML content of the page.
Index Keywords	`indexKeywords`	`string[]`	An array of strings containing keywords to be used when creating the page.