AdvancedIntegrations

Integrations and Extensions

Connect ONE with third-party tools and services to streamline your documentation workflow and enhance productivity.

const response = await fetch('https://api.example.com/v1/pages?projectId=proj_123abc', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});
const pages = await response.json();
{
  "pages": [
    {
      "id": "page_456def",
      "title": "Welcome",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  ]
}

Overview

ONE supports seamless integrations with popular third-party services, allowing you to automate workflows, receive notifications, and extend functionality. Use webhooks for real-time updates, the REST API for custom applications, and embedding options to incorporate external content directly into your documentation pages.

Start with popular integrations like Slack or GitHub to quickly enhance your setup. Review the API documentation for advanced customizations.

Explore these ready-to-use integrations to supercharge your ONE documentation workflow.

Setting Up Webhooks

Webhooks enable real-time notifications when events occur in ONE, such as page updates or new comments. Configure them in your project settings.

Navigate to Settings

Go to your project dashboard and select Integrations > Webhooks.

Add Webhook URL

Enter your webhook endpoint, like https://your-webhook-url.com/one-events.

Select Events

Choose events such as page.updated or comment.created.

Test and Save

Send a test payload and save the configuration.

Example webhook payload:

{
  "event": "page.updated",
  "projectId": "proj_123abc",
  "pageId": "page_456def",
  "timestamp": "2024-01-15T10:30:00Z",
  "userId": "user_789ghi"
}

API Access for Custom Extensions

Build custom integrations using ONE's REST API at https://api.example.com/v1. Authenticate with your API key.

header
Authorizationstring
Required

Bearer token: Bearer YOUR_API_KEY

query
projectIdstring
Required

Your project identifier.

Fetch pages example:

Embedding External Content

Embed third-party content like videos, forms, or dashboards directly into ONE pages using iframes or custom scripts.

Use standard iframe syntax for secure embedding.

<Iframe
  src="https://example.com/dashboard"
  title="Embedded Dashboard"
  width="100%"
  height="600"
/>

Test embeds in preview mode to ensure they render correctly and comply with security policies.

Next Steps

API Reference

Dive deeper into full API endpoints and authentication methods.

Custom Scripts

Learn to write and deploy custom JavaScript extensions.