API Integration

Integration Overview

You integrate Manu Documentation with various external tools to streamline your workflow. These integrations automate documentation updates and improve collaboration.

GitHub Integration

You connect GitHub repositories to automatically sync documentation changes. This keeps your docs up-to-date with code changes.

{
"event": "push",
"repository": {
  "name": "my-docs",
  "owner": "my-org"
},
"commits": [
  {
    "modified": ["README.md", "api-docs/endpoints.md"],
    "added": ["new-feature.md"],
    "removed": ["deprecated.md"]
  }
]
}

const github = new GitHubClient({
token: process.env.GITHUB_TOKEN
});

const syncResult = await github.syncDocs({
repo: 'my-org/my-docs',
branch: 'main',
folder: 'docs/'
});

console.log(`Synced ${syncResult.files.length} files`);

Slack Integration

You configure Slack notifications for documentation events. Get notified when team members make changes or when reviews are requested.

Jira Integration

You link documentation to Jira issues for better project tracking. This creates a seamless workflow between development and documentation.

Webhook Configuration

You set up webhooks to receive real-time notifications about documentation changes. Webhooks enable custom integrations with your existing tools.

const express = require('express');
const app = express();

app.post('/webhook/manu-docs', (req, res) => {
const { event, document, changes } = req.body;

console.log(`Document ${document.title} was ${event}`);

// Handle the webhook
if (event === 'updated') {
  // Send notification or trigger CI/CD
}

res.status(200).send('OK');
});

app.listen(3000);

from flask import Flask, request

app = Flask(__name__)

@app.route('/webhook/manu-docs', methods=['POST'])

def handle_webhook():
  data = request.get_json()
  event = data['event']
  document = data['document']
  
  print(f"Document {document['title']} was {event}")
  
  if event == 'updated':
      # Send notification or trigger action
      pass
  
  return 'OK', 200

if __name__ == '__main__':
  app.run(port=3000)

API Endpoints

You use specific API endpoints for integration purposes. These endpoints allow programmatic access to documentation features.

Troubleshooting Integrations

If integrations fail, you check these common issues. Most problems stem from authentication or configuration errors.