Webhook Integration

Send article data to any custom endpoint for flexible integration.

Overview

The webhook integration allows you to send article data to any custom HTTP endpoint. This is perfect for custom CMS integrations, automation workflows, or connecting to platforms not natively supported.

Use Cases

  • Custom CMS platforms
  • Headless CMS integrations
  • Automation workflows (Make, n8n, etc.)
  • Content syndication
  • Custom content pipelines
  • Internal content management systems

Setup Instructions

Step 1: Configure Webhook URL

  1. Go to Integrations in Sight AI
  2. Click Webhook
  3. Enter your webhook endpoint URL
  4. Select the HTTP method (POST is default)
  5. Add any custom headers if needed
  6. Click "Save"

Step 2: Test the Connection

  1. Click "Send Test"
  2. Verify your endpoint receives the test payload
  3. Check the response status

Payload Format

When an article is synced, Sight AI sends a JSON payload to your endpoint:

{
  "event": "article.published",
  "timestamp": "2024-01-15T10:30:00Z",
  "article": {
    "id": "article_abc123",
    "title": "Article Title",
    "slug": "article-title",
    "content": "<p>Full HTML content...</p>",
    "excerpt": "Article summary...",
    "featured_image": {
      "url": "https://...",
      "alt": "Image description"
    },
    "images": [
      {
        "url": "https://...",
        "alt": "Image description"
      }
    ],
    "meta": {
      "title": "SEO Title",
      "description": "Meta description"
    },
    "keyword": "target keyword",
    "type": "explainer",
    "word_count": 2500,
    "created_at": "2024-01-15T10:30:00Z"
  },
  "site": {
    "id": "site_xyz789",
    "name": "Your Site Name",
    "url": "https://yoursite.com"
  }
}

Configuration Options

HTTP Method

Choose the HTTP method for your webhook:

  • POST – Most common, sends data in request body
  • PUT – For update-style operations

Custom Headers

Add custom headers for authentication or identification:

  • Authorization – API key or bearer token
  • X-API-Key – Custom API key header
  • Content-Type – Defaults to application/json

Webhook Secret

For security, Sight AI includes a signature header:

X-Sight-Signature: sha256=abc123...

Use this to verify webhooks are from Sight AI.

Event Types

EventDescription
article.publishedArticle was synced/published
article.updatedArticle was updated and re-synced
testTest webhook from Sight AI

Response Handling

Your endpoint should respond with:

  • 200-299 – Success, delivery confirmed
  • 4xx – Client error, will not retry
  • 5xx – Server error, Sight AI will retry

Respond within 30 seconds to avoid timeout.

Retry Policy

Failed webhooks (5xx responses or timeouts) are retried:

  • First retry: 1 minute after failure
  • Second retry: 5 minutes after first retry
  • Third retry: 15 minutes after second retry
  • Maximum 3 retries before marking as failed

Delivery Logs

View webhook delivery history:

  1. Go to Integrations → Webhook
  2. Click "View Logs"
  3. See recent deliveries with status and response

Example Integrations

Zapier (via Webhooks by Zapier)

  1. Create a new Zap with "Webhooks by Zapier" trigger
  2. Select "Catch Hook"
  3. Copy the webhook URL
  4. Paste into Sight AI webhook configuration
  5. Set up your Zap actions

Make (formerly Integromat)

  1. Create a new scenario with Webhook module
  2. Select "Custom webhook"
  3. Copy the webhook URL
  4. Configure in Sight AI
  5. Add your Make actions

Troubleshooting

Webhook Not Received

  • Verify the endpoint URL is correct and accessible
  • Check for firewall or IP restrictions
  • Ensure your server is running and responding
  • Review delivery logs for error details

Authentication Failed

  • Verify custom headers are configured correctly
  • Check API key or token validity
  • Ensure header names match what your endpoint expects

Disconnecting

To disable the webhook:

  1. Go to Integrations → Webhook
  2. Click "Disable" or delete the webhook URL
  3. Save changes

Next Steps