Qpage
AdvancedIntegrations

Integrations and Extensions

Learn how to connect Qpage with external tools and services to streamline your documentation workflow and enhance functionality.

Overview

Qpage supports seamless integrations with Git for version control, APIs for programmatic access, webhooks for real-time notifications, and embedding options for third-party content. These features enable you to automate workflows, sync documentation with your codebase, and enrich your docs with dynamic elements.

Git Sync

Keep your documentation in sync with your repository changes.

API Access

Automate documentation management via RESTful endpoints.

Webhooks

Receive instant notifications on document updates.

Embed Content

Integrate charts, forms, and videos from external services.

Git Integration

Connect Qpage to your Git repository to automatically publish documentation updates on commits or pull requests.

Connect Repository

In your Qpage dashboard, navigate to Settings > Integrations > Git.

Select your provider (GitHub, GitLab, or Bitbucket) and authorize access.

Configure Branch

Specify the branch to watch, such as main or docs.

# Example GitHub webhook payload trigger
git push origin main

Enable Auto-Publish

Toggle auto-publish. Qpage pulls Markdown files from /docs folder and deploys them.

Use a dedicated docs/ folder in your repo for clean separation from application code.

API Access

Qpage provides a REST API for creating, updating, and querying documents programmatically.

path
docIdstring
Required

Unique document identifier.

header
Authorizationstring
Required

Bearer token: Bearer YOUR_API_KEY.

const response = await fetch('https://api.example.com/v1/docs/{docId}', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});
const doc = await response.json();
console.log(doc);

Webhooks

Set up webhooks to notify external services when documents change. Configure the URL in your Qpage project settings.

Use Incoming Webhooks.

// Payload received by your endpoint
{
  "event": "doc.updated",
  "docId": "abc123",
  "url": "https://docs.example.com/doc/abc123"
}

Embedding Third-Party Content

Embed interactive content like charts or forms directly into your Qpage documents.

Next Steps

Explore these integrations to supercharge your workflow.

API Reference

Full endpoint documentation and SDKs.

Custom Scripts

Build advanced automations with webhooks.

Test integrations in a sandbox project first to avoid disrupting production docs.

Was this page helpful?

Last updated today

Built with Documentation.AI