integrations.mdx

title	Integrations and Extensions
description	Extend your documentation workflow by connecting with third-party services and tools.

Overview

Connect Yassine Fatihi's documentation platform with your favorite tools to streamline workflows. You can integrate project management apps, set up webhooks for real-time updates, use API endpoints for custom automation, handle exports and imports in various formats, and embed external resources seamlessly.

Review your integration permissions before connecting services to ensure secure data flow.

Project Management Integrations

Link your documentation to popular project management tools for synchronized updates and task tracking.

Sync tasks and projects directly. Attach docs to Asana tasks for team collaboration. Connect repositories to auto-generate docs from code changes and issues. Send doc updates and notifications to Slack channels instantly.

Webhook Configuration

Set up webhooks to receive real-time events from external services. This triggers documentation updates automatically.

Navigate to your account settings and select "Integrations".

Generate a new webhook URL using this endpoint:

const webhookUrl = 'https://api.example.com/v1/webhooks';

Define the event payload structure.

<CodeGroup tabs="JSON,cURL">

{
  "event": "doc.updated",
  "data": {
    "id": "doc-123",
    "title": "Updated Guide"
  }
}

curl -X POST https://your-webhook-url.com/webhook \
  -H "Content-Type: application/json" \
  -d '{"event": "doc.updated", "data": {"id": "doc-123"}}'

</CodeGroup>

Send a test event and verify receipt in your logs.

Custom API Integrations

Build advanced automations using our REST API endpoints.

Webhook endpoint path. `Bearer YOUR_TOKEN` ````javascript const response = await fetch('https://api.example.com/v1/integrations', { method: 'POST', headers: { 'Authorization': 'Bearer YOUR_TOKEN', 'Content-Type': 'application/json' }, body: JSON.stringify({ name: 'Custom Webhook', url: 'https://your-webhook-url.com/webhook' }) }); ````

curl -X POST https://api.example.com/v1/integrations \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Custom Webhook",
    "url": "https://your-webhook-url.com/webhook"
  }'

```json { "success": true, "webhook_id": "wh_456abc", "url": "https://api.example.com/v1/webhooks/wh_456abc" } ```

Export and Import Formats

Export your documentation in multiple formats for backups or migrations.

Ideal for GitHub repos and static sites.

# Sample Doc
Content here.

Structured data for API imports.

{
  "title": "Sample Doc",
  "content": "Content here.",
  "format": "md"
}

Printable format for sharing.

Embedding External Resources

Embed iframes, videos, or widgets from third-party services.

Use secure origins only. Example iframe embed: ````html <iframe src="https://example.com/widget" width="100%" height="400"></iframe> ````

For videos:

<Video src="https://www.youtube.com/embed/dQw4w9WgXcQ" title="Demo Video" width="560" height="315" />

Start with project management integrations for quick wins, then explore webhooks for automation.