Core Concepts

Integrations and Extensions

Connect John Le with external tools to enhance your documentation workflow.

const response = await fetch('https://api.example.com/v1/docs', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${YOUR_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    title: 'New Doc',
    content: 'Hello from API!'
  })
});

curl -X POST https://api.example.com/v1/docs \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "New Doc",
    "content": "Hello from API!"
  }'

{
  "event": "doc.updated",
  "timestamp": "2024-10-15T10:30:00Z",
  "data": {
    "doc_id": "doc_123abc",
    "title": "Updated Guide",
    "url": "https://docs.example.com/guide"
  }
}

Overview

John Le supports seamless integrations with popular tools to streamline your documentation processes. Integrate with version control systems, automate via APIs, set up webhooks for real-time notifications, connect third-party apps, and embed external content directly into your docs.

Start with Git integration for version control, then explore APIs and webhooks for advanced automation.

Key Integrations

Git

Sync your documentation with Git repositories for collaborative editing.

API Access

Build custom automations using our REST API.

Webhooks

Receive instant notifications on documentation events.

Third-party Apps

Connect with Slack, Discord, and more.

Embed Content

Embed videos, charts, and iframes effortlessly.

Git Integration

Connect your John Le workspace to GitHub or GitLab for automatic syncing.

Connect Repository

In your workspace settings, navigate to Integrations > Git.

Enter your repository URL: https://github.com/your-org/your-docs-repo.git.

Authenticate

# GitHub Personal Access Token
export GITHUB_TOKEN=your-github-token-here

Sync Changes

Push changes to your repo branch. John Le pulls updates automatically every 5 minutes.

API Access

Use our REST API to manage documentation programmatically.

Document title.

Bearer token for authentication.

Webhook Setup

Set up webhooks to notify external services on events like doc updates.

Create Webhook

Add Webhook URL

Go to Workspace > Webhooks > New Webhook.

Enter your endpoint: https://your-webhook-url.com/docs-events.

Select Events

Choose events: doc.created, doc.updated, doc.published.

Test Delivery

Trigger a test event to verify.

Expected Payload

Third-party Apps

Send notifications to a Slack channel on doc changes.

// Slack incoming webhook
fetch('https://hooks.slack.com/services/YOUR/SLACK/WEBHOOK', {
  method: 'POST',
  body: JSON.stringify({
    text: 'New doc published: https://docs.example.com/new-guide'
  })
});

Post updates to Discord using webhooks.

// Discord webhook
fetch('https://discord.com/api/webhooks/YOUR/WEBHOOK/URL', {
  method: 'POST',
  body: JSON.stringify({
    content: 'Documentation updated!'
  })
});

Embedding External Content

Embed iframes, videos, or charts directly in your docs.

<iframe
  src="https://example.com/dashboard"
  width="100%"
  height="400"
  frameborder="0">
</iframe>

Customize embeds with responsive sizing for better mobile experience.

Next Steps

Explore these integrations to supercharge your workflow. For more details, check the API Reference or Changelog.

Was this page helpful?

Built with Documentation.AI

Last updated today