Create Document with Document360 API on New Media Upload Complete from Sonix API

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

Trigger workflow on

New Media Upload Complete from the Sonix API

Next, do this

Create Document with the Document360 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 Sonix trigger and Document360 action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Media Upload Complete trigger
1. Connect your Sonix account
2. Configure timer
Configure the Create Document action
1. Connect your Document360 account
2. Select a Project Version ID
3. Select a Category ID
4. Configure Document Title
5. Select a User ID
6. Configure Document Content
7. Optional- Configure Document Order
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 Media Upload Complete on Sonix

Description:Emit new event any time the media status of an item changes to completed.

Version:0.0.1

Key:sonix-media-upload-complete

View on GitHub

Sonix Overview#

The Sonix API enables automated transcription of audio and video files into text, offering functions like uploading media, managing files, and retrieving transcripts. Leveraging Pipedream’s capabilities, you can integrate the Sonix API with various services to streamline media processing workflows, making transcription tasks more efficient. By automating interactions with Sonix, you can trigger actions based on the transcription status, analyze content, and connect transcribed text with other apps for further processing or analysis.

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import sonix from "../../sonix.app.mjs";

export default {
  key: "sonix-media-upload-complete",
  name: "New Media Upload Complete",
  description: "Emit new event any time the media status of an item changes to completed.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    sonix,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  methods: {
    _getLastDate() {
      return this.db.get("lastDate") ?? 0;
    },
    _setLastDate(status) {
      this.db.set("lastDate", status);
    },
    async startEvent(maxResults = 0) {
      const lastDate = this._getLastDate();
      const items = this.sonix.paginate({
        fn: this.sonix.listMedia,
        maxResults,
        params: {
          status: "completed",
        },
      });

      let responseArray = [];

      for await (const item of items) {
        if (new Date(item.created_at) <= new Date(lastDate)) break;
        responseArray.push(item);
      }
      if (responseArray.length) this._setLastDate(responseArray[0].created_at);

      for (const item of responseArray.reverse()) {
        this.$emit(
          item,
          {
            id: item.id,
            summary: `Media upload completed: ${item.name}`,
            ts: Date.parse(item.created_at),
          },
        );
      }
    },
  },
  hooks: {
    async deploy() {
      await this.startEvent(25);
    },
  },
  async run() {
    await this.startEvent();
  },
};

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
Sonix	`sonix`	`app`	This component uses the Sonix app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

About Sonix#

Automated transcription, translation, and subtitling. Over 40 languages supported. Fast, accurate, and affordable.

Action#

Create Document on Document360

Description:Creates a new document in Document360 from text. [See the documentation](https://apidocs.document360.com/apidocs/how-to-create-and-publish-an-article)

Version:0.0.1

Key:document360-create-document

View on GitHub

Document360 Overview#

The Document360 API enables programmatic interaction with your knowledge base, allowing you to automate content creation, updates, and management. With this API, you can integrate Document360 into your existing content pipelines, support workflows, or any system that needs to push or pull knowledge base content. On Pipedream, you can harness this API to craft serverless workflows that seamlessly integrate with other apps to keep documentation up-to-date, trigger notifications based on content changes, or analyze knowledge base usage.

Action Code#

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

export default {
  key: "document360-create-document",
  name: "Create Document",
  description: "Creates a new document in Document360 from text. [See the documentation](https://apidocs.document360.com/apidocs/how-to-create-and-publish-an-article)",
  version: "0.0.1",
  type: "action",
  props: {
    document360,
    projectVersionId: {
      propDefinition: [
        document360,
        "projectVersionId",
      ],
    },
    categoryId: {
      propDefinition: [
        document360,
        "categoryId",
        ({ projectVersionId }) => ({
          projectVersionId,
        }),
      ],
    },
    title: {
      type: "string",
      label: "Document Title",
      description: "The title of the new document.",
    },
    userId: {
      propDefinition: [
        document360,
        "userId",
      ],
    },
    content: {
      type: "string",
      label: "Document Content",
      description: "The content of the new document.",
    },
    order: {
      type: "integer",
      label: "Document Order",
      description: "The order position of the document within the category. For example, `0` will be the first in the category, `4` will be the fifth in the category.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.document360.createDocument({
      $,
      data: {
        category_id: this.categoryId,
        project_version_id: this.projectVersionId,
        title: this.title,
        user_id: this.userId,
        content: this.content,
        order: this.order,
      },
    });

    if (!response.success) {
      $.export("response", response);
      throw new Error("Failed to create document - see the API response for more details.");
    }

    $.export("$summary", `Successfully created document "${this.title}"`);
    return response;
  },
};

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
Document360	`document360`	`app`	This component uses the Document360 app.
Project Version ID	`projectVersionId`	`string`	Select a value from the drop down menu.
Category ID	`categoryId`	`string`	Select a value from the drop down menu.
Document Title	`title`	`string`	The title of the new document.
User ID	`userId`	`string`	Select a value from the drop down menu.
Document Content	`content`	`string`	The content of the new document.
Document Order	`order`	`integer`	The order position of the document within the category. For example, `0` will be the first in the category, `4` will be the fifth in the category.