Skip to content

integrations.mdx

Latest commit

 

History

History
177 lines (146 loc) · 4.61 KB

integrations.mdx

File metadata and controls

177 lines (146 loc) · 4.61 KB
title Integrations and Extensions
description Learn how to connect Atriabyte Digital with third-party tools to automate workflows and enhance your documentation ecosystem.

Overview

Atriabyte Digital supports seamless integrations with version control systems, content management systems, webhooks, and custom APIs. These connections enable automated documentation updates, version syncing, and workflow automation. Start by reviewing available options and follow the setup guides for your preferred tools.

Review your Atriabyte Digital plan to ensure integration features are enabled. Contact support if needed.

Git Version Control Integration

Connect your Git repositories to automatically sync documentation changes. Push updates to your repo, and Atriabyte Digital rebuilds your docs site.

In your Git provider dashboard, add a webhook pointing to your Atriabyte Digital sync URL. Select events like `push` and `pull_request` to trigger builds. Push a commit and verify docs update in your dashboard. ````javascript // GitHub Webhook Payload Example { "ref": "refs/heads/main", "repository": { "full_name": "your-org/docs" }, "pusher": { "name": "user" } } ```` 
// GitLab Webhook Payload Example
{
  "ref": "refs/heads/main",
  "project": {
    "path_with_namespace": "your-group/docs"
  },
  "user_name": "user"
}

CMS Connections

Integrate with popular CMS platforms to pull content dynamically into your docs.

Use the Atriabyte Digital WordPress plugin or REST API. 
<ParamField path="posts" param-type="array" required="true">
  Array of blog posts to sync.
</ParamField>

```bash
curl -H "Authorization: Bearer YOUR_API_KEY" \
     https://api.example.com/cms/wordpress/sync
```
Set up a Contentful app with webhooks. 
```javascript
const contentful = require('contentful');
const client = contentful.createClient({
  space: 'YOUR_SPACE_ID',
  accessToken: 'YOUR_ACCESS_TOKEN'
});
```

Webhooks for Automation

Webhooks allow external services to notify Atriabyte Digital of events, triggering builds or updates.

Configure a webhook endpoint at https://api.example.com/v1/webhooks.

````bash curl -X POST https://api.example.com/v1/webhooks \ -H "Content-Type: application/json" \ -H "Authorization: Bearer YOUR_WEBHOOK_TOKEN" \ -d '{ "event": "content.updated", "payload": {"doc_id": "123"} }' ```` 
fetch('https://api.example.com/v1/webhooks', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_WEBHOOK_TOKEN'
  },
  body: JSON.stringify({
    event: 'content.updated',
    payload: { doc_id: '123' }
  })
});
```json { "status": "success", "webhook_id": "wh_456", "message": "Build triggered" } ``` 
{
  "status": "error",
  "message": "Invalid token"
}

API Access for Custom Integrations

Build custom solutions using the Atriabyte Digital REST API. Authenticate with YOUR_API_KEY.

Bearer token: `Bearer YOUR_API_KEY`. Filter by project ID.

Popular Third-Party Apps

Discover ready-to-use integrations.

Get build alerts in your Slack channel. Automate workflows with 5000+ apps. Deploy docs sites with CI/CD. Enable HMAC signatures for webhook verification. 
const crypto = require('crypto');
const signature = crypto
  .createHmac('sha256', 'YOUR_WEBHOOK_SECRET')
  .update(payload)
  .digest('hex');
Explore the [API reference](/authentication) for full endpoint details and start building today.