GuidesIntegrations

Integrations

How to connect Unecast with external tools, services, and automate workflows.

Overview

Unecast supports seamless integrations with popular tools to automate your workflows. Connect your GitHub repositories for automatic documentation syncing, set up webhooks for real-time events, embed content in third-party apps, and handle exports or imports effortlessly.

All integrations require a valid API key from your Unecast dashboard at https://dashboard.example.com.

GitHub Sync

Sync your GitHub repository with Unecast to keep documentation up-to-date automatically.

Create a Personal Access Token

In GitHub, go to Settings > Developer settings > Personal access tokens. Generate a new token with repo scope.

Connect in Unecast Dashboard

Navigate to Integrations > GitHub in your dashboard. Paste the token and select your repository.

Configure Sync Rules

Set paths to watch, like docs/*.mdx, and enable auto-publish on push.

Once set up, pushes to your repo trigger rebuilds in under {<1min}.

Webhook Setup

Webhooks let you react to Unecast events like document updates or user actions. Configure them via the dashboard or API.

path
webhook_urlstring
Required

Your endpoint URL, e.g., https://your-webhook-url.com/webhook.

header
Unecast-Signaturestring

HMAC SHA-256 signature for verification using your secret.

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

app.post('/webhook', express.raw({type: 'application/json'}), (req, res) => {
  const signature = `Unecast-Signature: ${crypto.createHmac('sha256', 'YOUR_SECRET').update(req.body).digest('hex')}`;
  console.log('Event:', JSON.parse(req.body.toString()));
  res.status(200).send('OK');
});

app.listen(3000);

Always verify signatures to prevent replay attacks. Test webhooks using the dashboard's "Send Test" button.

Third-party Embeds

Embed Unecast pages or components in tools like Slack, Notion, or your website.

Use this snippet to post dynamic embeds:

<iframe src="https://docs.example.com/embed/page-id" width="100%" height="400" frameborder="0"></iframe>

Paste into Slack's custom app or message composer.

Export and Import Options

Export your documentation as Markdown, PDF, or JSON. Import from GitHub, Google Docs, or ZIP files.

FormatExportImportUse Case
MarkdownYesYesGit repos, static sites
PDFYesNoPrinting, sharing
JSONYesYesAPI migrations
Live
2

GitHub Sync

Full two-way sync

Slack Embeds

Rich previews

Beta
1

Notion Import

Direct from pages

Jan 15, 2025
Planned
1

Zapier

No-code automations