Outline icon

Outline

Interact with Outline knowledge base
Join our community

Actions53

Overview

This node integrates with the Outline knowledge base platform, allowing users to programmatically manage documents and other resources within Outline. Specifically, the "Document - Create" operation enables creating new documents in a specified collection, optionally publishing them immediately or marking them as templates.

Common scenarios for this node include:

  • Automating documentation workflows by creating new knowledge base articles from external data sources.
  • Integrating with content management systems to sync or generate documentation automatically.
  • Creating draft or published documents based on user input or system events.

For example, you could use this node to create a new document titled "API Usage Guide" in a specific collection, with markdown content describing API endpoints, and publish it immediately for team access.

Properties

Name Meaning
Document Title The title of the document to be created.
Collection ID The ID of the collection where the document will be created. Optional; if omitted, document is created without specifying a collection.
Content The main content of the document in markdown format. Optional.
Publish Boolean flag indicating whether to publish the document immediately after creation. Defaults to true.
Parent Document ID The ID of the parent document under which this document should be nested. Optional.
Template Boolean flag indicating whether to create the document as a reusable template. Defaults to false.

Output

The output JSON contains the response from the Outline API after creating the document. This typically includes details about the newly created document such as its unique ID, title, content, publication status, timestamps, and any associated metadata.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": "string",
  "title": "string",
  "text": "string",
  "published": true,
  "collectionId": "string",
  "parentDocumentId": "string",
  "template": false,
  "createdAt": "string",
  "updatedAt": "string"
}

Dependencies

  • Requires an API key credential for authenticating with the Outline API.
  • The node makes HTTP POST requests to Outline's REST API endpoints.
  • No additional environment variables are required beyond the API authentication setup.

Troubleshooting

  • Authentication errors: Ensure that the API key credential is correctly configured and has sufficient permissions to create documents.
  • Invalid Collection ID: If the provided collection ID does not exist or the user lacks access, the API will return an error. Verify the collection ID is correct.
  • Missing required fields: The "Document Title" is mandatory. Omitting it will cause the request to fail.
  • Markdown content issues: While the content field accepts markdown, invalid formatting won't cause failure but may affect rendering in Outline.
  • Network or API errors: Transient network issues or API downtime can cause failures. Retrying or checking Outline service status is recommended.

Links and References

Discussion