Core ConceptsIntegrations

Integrations and Extensions

Connect Next Step Conrad with third-party tools and services to enhance your documentation workflow and automate processes.

curl -X GET "https://api.nextstepconrad.com/v1/documents" \
  -H "Authorization: Bearer YOUR_API_KEY"
{
  "documents": [
    {
      "id": "doc_123",
      "title": "Introduction",
      "updated_at": "2024-10-15T10:00:00Z"
    }
  ]
}

Overview

Next Step Conrad supports seamless integrations with popular tools to streamline your documentation workflow. You can connect version control systems like GitHub, set up webhooks for real-time updates, link content management systems, and use the API for custom solutions. These integrations help automate publishing, sync content, and trigger actions on events.

Start with GitHub for version control integration, then explore webhooks and API options for advanced automation.

GitHub Integration

Connect your GitHub repository to Next Step Conrad to automatically build and deploy documentation on commits or pull requests.

Create a Repository Webhook

In your GitHub repo settings, navigate to Webhooks and add a new webhook pointing to your Next Step Conrad endpoint.

Configure Payload

Select application/json as content type and include push events.

Generate Secret

Create a webhook secret in Next Step Conrad dashboard and paste it into GitHub.

Test Connection

Push a commit to trigger the webhook and verify deployment.

Webhooks for Real-Time Updates

Use webhooks to receive instant notifications from Next Step Conrad when documents update, builds complete, or errors occur. Configure your endpoint to handle POST requests.

const express = require('express');
const app = express();
app.use(express.json());

app.post('/webhook', (req, res) => {
  const event = req.headers['x-nextstepconrad-event'];
  if (event === 'doc.updated') {
    console.log('Document updated:', req.body);
  }
  res.status(200).send('OK');
});

app.listen(3000);

Connect to Content Management Systems

Link Next Step Conrad to your CMS for bidirectional sync. Choose from popular options below.

API Access for Custom Integrations

Build custom tools using the Next Step Conrad REST API. Authenticate with an API key.

header
Authorizationstring
Required

Bearer token: Bearer YOUR_API_KEY

query
projectstring

Filter by project ID.

Example: Fetch recent documents.

Best Practices for Secure Connections

Follow these guidelines to keep integrations safe.

Always use HTTPS endpoints and rotate secrets regularly.

Check webhook delivery logs in the dashboard. Verify payload format matches expected schema.