Advanced

Integrations and Extensions

Connect MineHub with your favorite tools and services to enhance your documentation process and automate workflows.

const response = await fetch('https://api.example.com/v1/projects/{project_id}/documents', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
});
const docs = await response.json();

{
  "documents": [
    {
      "id": "doc_456def",
      "title": "API Guide",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ]
}

Overview

MineHub supports seamless integrations with popular third-party services, webhooks for real-time notifications, and a robust API for custom solutions. You can connect tools like GitHub for version control, Slack for team alerts, and more. Import content from Google Docs or export to Markdown for flexibility. Follow best practices to keep integrations secure and efficient.

Start with official integrations for quick setup, then explore webhooks and API for advanced automation.

Popular Third-Party Integrations

Use these pre-built connections to extend MineHub's capabilities.

GitHub

Sync repositories with documentation projects. Automatically update docs on commits.

Slack

Send notifications for document updates, approvals, and mentions.

Google Workspace

Import from Google Docs and Sheets for collaborative editing.

Set Up Webhooks

Webhooks enable real-time event notifications to your external services.

Create Webhook

Navigate to your project settings and select "Webhooks". Click "New Webhook".

Configure Endpoint

Enter your webhook URL, such as https://your-webhook-url.com/minehub.

Select events like document.updated or comment.added.

Test and Save

Send a test payload and verify receipt. Save the webhook.

Here is an example webhook payload:

{
  "event": "document.updated",
  "project_id": "proj_123abc",
  "document_id": "doc_456def",
  "user_id": "user_789ghi",
  "timestamp": "2024-01-15T10:30:00Z"
}

API Integrations

Access MineHub's REST API at https://api.example.com/v1 for custom integrations. Authenticate with {API_KEY} in the Authorization header.

header

Authorizationstring

Required

Bearer {YOUR_API_KEY}

header

Content-Typestring

Required

application/json

Example: Fetch project documents.

Import and Export Options

Format	Import	Export	Use Case
Google Docs	✅	✅	Collaborative editing
Markdown	✅	✅	Git-based workflows
HTML	✅	✅	Web publishing
PDF	❌	✅	Sharing finalized docs

Use the import tool in project settings. Select your Doc and map sections.

Best Practices and Security

Rotate {API_KEY} regularly.
Use IP allowlists for webhooks.
Validate payloads with HMAC signatures.
Limit scopes to minimal permissions.

Never expose {API_KEY} in client-side code or public repositories.

Next Steps

API Reference

Dive into full API documentation.

Troubleshooting

Common integration issues and fixes.

Was this page helpful?

Built with Documentation.AI

Last updated 2 days ago