logo_smallAxellero.io

Outline

Professional knowledge management and team documentation platform with comprehensive document collaboration capabilities.

Outline Node

Comprehensive integration with Outline, a professional knowledge management platform, enabling automated document management, team collaboration, and knowledge base operations in Axellero workflows.

Available Operations

  • Document Management: Create, update, retrieve, search, and delete documents
  • Collection Management: Organize documents with comprehensive collection operations
  • User Management: Access user profiles and team collaboration features
  • Comment System: Manage document comments and discussions
  • Export Capabilities: Export collections to multiple formats (PDF, HTML, Markdown)

Connection Configuration

ParameterTypeRequiredDescription
apiKeyTEXTYesOutline API key from Settings → API Keys in your workspace
baseUrlTEXTNoOutline API base URL (default: https://app.getoutline.com/api)
{
  "apiKey": "{{ctx.consts.OUTLINE_API_KEY}}",
  "baseUrl": "{{ctx.consts.OUTLINE_BASE_URL}}"
}

Document Operations

createDocument

Create a new document in Outline with rich content and collection assignment.

ParameterTypeRequiredDescription
titleTEXTYesDocument title
textTEXTNoDocument content in Markdown format
collectionIdTEXTNoCollection ID for document placement
parentDocumentIdTEXTNoParent document ID for nested structure
templateIdTEXTNoTemplate document ID to use as base
publishBOOLEANNoWhether to publish document immediately
{
  "title": "{{ctx.vars.documentTitle}} - {{ctx.user.department}}",
  "text": "{{ctx.nodes.contentProcessor.outputs.markdownContent}}",
  "collectionId": "{{ctx.vars.targetCollectionId}}",
  "publish": true
}

updateDocument

Update existing document content and properties.

ParameterTypeRequiredDescription
idTEXTYesDocument ID to update
titleTEXTNoUpdated document title
textTEXTNoUpdated content in Markdown format
appendBOOLEANNoWhether to append text instead of replacing
{
  "id": "{{ctx.vars.documentId}}",
  "title": "{{ctx.vars.updatedTitle}}",
  "text": "{{ctx.nodes.contentGenerator.outputs.updatedContent}}",
  "append": false
}

getDocument

Retrieve detailed information about a specific document including content and metadata.

ParameterTypeRequiredDescription
idTEXTYesDocument ID to retrieve
shareIdTEXTNoShare ID for publicly shared documents
{
  "id": "{{ctx.vars.documentId}}"
}

listDocuments

Retrieve documents with advanced filtering and pagination support.

ParameterTypeRequiredDescription
collectionIdTEXTNoFilter by collection ID
userIdTEXTNoFilter by document author
offsetINTNoPagination offset
limitINTNoMaximum documents to return (max 100)
sortTEXTNoSort order: updatedAt, createdAt, index, title
directionTEXTNoSort direction: ASC or DESC
{
  "collectionId": "{{ctx.vars.collectionId}}",
  "sort": "updatedAt",
  "direction": "DESC",
  "limit": 50
}

searchDocuments

Search documents with advanced filtering and pagination.

ParameterTypeRequiredDescription
queryTEXTYesSearch query string
collectionIdTEXTNoLimit search to specific collection
userIdTEXTNoFilter by document author
dateFilterTEXTNoDate filter: day, week, month, year
includeArchivedBOOLEANNoInclude archived documents
offsetINTNoPagination offset
limitINTNoMaximum results to return
{
  "query": "{{ctx.vars.searchTerm}}",
  "collectionId": "{{ctx.vars.collectionFilter}}",
  "dateFilter": "month",
  "includeArchived": false
}

deleteDocument

Move document to trash or permanently delete it.

ParameterTypeRequiredDescription
idTEXTYesDocument ID to delete
permanentBOOLEANNoWhether to permanently delete (default: false)
{
  "id": "{{ctx.vars.documentId}}",
  "permanent": false
}

restoreDocument

Restore a document from trash back to active state.

ParameterTypeRequiredDescription
idTEXTYesDocument ID to restore
collectionIdTEXTNoCollection ID to restore to
{
  "id": "{{ctx.vars.documentId}}",
  "collectionId": "{{ctx.vars.targetCollectionId}}"
}

Collection Management Operations

createCollection

Create a new collection for organizing documents.

ParameterTypeRequiredDescription
nameTEXTYesCollection name (max 100 characters)
descriptionTEXTNoCollection description
colorTEXTNoCollection color in hex format
iconTEXTNoCollection icon name
permissionTEXTNoPermission level: read, read_write
{
  "name": "{{ctx.vars.collectionName}}",
  "description": "{{ctx.vars.collectionDescription}}",
  "color": "#4F46E5",
  "permission": "read_write"
}

updateCollection

Update collection properties and settings.

ParameterTypeRequiredDescription
idTEXTYesCollection ID to update
nameTEXTNoUpdated collection name
descriptionTEXTNoUpdated description
colorTEXTNoUpdated color in hex format
iconTEXTNoUpdated icon name
permissionTEXTNoUpdated permission level
{
  "id": "{{ctx.vars.collectionId}}",
  "name": "{{ctx.vars.updatedName}}",
  "description": "{{ctx.vars.updatedDescription}}"
}

getCollection

Retrieve collection details and metadata.

ParameterTypeRequiredDescription
idTEXTYesCollection ID to retrieve
{
  "id": "{{ctx.vars.collectionId}}"
}

listCollections

Retrieve all accessible collections with pagination.

ParameterTypeRequiredDescription
offsetINTNoPagination offset (default: 0)
limitINTNoMaximum collections to return (max 100, default: 25)
{
  "limit": 50
}

deleteCollection

Delete an empty collection from the workspace.

ParameterTypeRequiredDescription
idTEXTYesCollection ID to delete
{
  "id": "{{ctx.vars.collectionId}}"
}

exportCollection

Export collection to various formats for backup or sharing.

ParameterTypeRequiredDescription
idTEXTYesCollection ID to export
formatTEXTNoExport format: outline-markdown, html, pdf, json, notion
{
  "id": "{{ctx.vars.collectionId}}",
  "format": "pdf"
}

User and Comment Operations

getUser

Retrieve detailed user information and permissions.

ParameterTypeRequiredDescription
idTEXTYesUser ID to retrieve
{
  "id": "{{ctx.vars.userId}}"
}

listUsers

Retrieve workspace users with filtering and pagination.

ParameterTypeRequiredDescription
offsetINTNoPagination offset
limitINTNoMaximum users to return (max 100)
sortTEXTNoSort order: createdAt, updatedAt, name
directionTEXTNoSort direction: ASC or DESC
queryTEXTNoSearch query for name or email
{
  "query": "{{ctx.vars.userSearchTerm}}",
  "sort": "name",
  "direction": "ASC"
}

createComment

Add a comment or reply to a document.

ParameterTypeRequiredDescription
documentIdTEXTYesDocument ID to comment on
textTEXTYesComment content (max 1000 characters)
parentCommentIdTEXTNoParent comment ID for replies
{
  "documentId": "{{ctx.vars.documentId}}",
  "text": "{{ctx.vars.commentText}}",
  "parentCommentId": "{{ctx.vars.parentCommentId}}"
}

listComments

Retrieve all comments for a document.

ParameterTypeRequiredDescription
documentIdTEXTYesDocument ID to list comments for
offsetINTNoPagination offset
limitINTNoMaximum comments to return (max 100)
{
  "documentId": "{{ctx.vars.documentId}}",
  "limit": 25
}

Workflow Integration

Use workflow context for dynamic knowledge management:

{
  "title": "{{ctx.vars.eventType}} Report - {{ctx.user.department}}",
  "text": "{{ctx.nodes.reportGenerator.outputs.markdownReport}}",
  "collectionId": "{{ctx.nodes.collectionSelector.outputs.targetCollection}}",
  "publish": "{{ctx.vars.autoPublish}}"
}

Response Format

Success Response

{
  "success": true,
  "id": "doc_abc123",
  "document": {
    "title": "Project Report",
    "text": "# Report Content...",
    "collectionId": "col_def456",
    "createdAt": "2024-12-13T10:00:00Z"
  }
}

Error Response

{
  "success": false,
  "error": "Document not found",
  "code": "NOT_FOUND"
}

Use Cases

  • Knowledge Base Management: Automatically create and update documentation from workflow events
  • Report Generation: Generate and publish reports based on data analysis workflows
  • Team Collaboration: Create shared documents and manage team discussions
  • Content Automation: Convert external content into organized knowledge base articles
  • Document Workflows: Automate document lifecycle including creation, updates, and archiving
  • Search and Discovery: Build intelligent content discovery systems for organizational knowledge