πŸ””βš™οΈπŸ“‘guidesSource: opendocs-core

Webhooks Guide

Set up webhooks to get notified when documentation changes.

1 min read122 words
Share:π•πŸ’ΌπŸ“˜πŸ”΄πŸŸ§

Webhooks Guide #

Webhooks allow you to receive real-time notifications when events occur in OpenDocs.

Supported Events #

  • document.created - New document published
  • document.updated - Document content changed
  • document.deleted - Document removed
  • submission.created - New submission received
  • submission.reviewed - Submission approved/rejected

Register a Webhook #

http 
POST /api/v1/webhooks
Authorization: Bearer YOURAPIKEY
Content-Type: application/json
json 
{
  "url": "https://your-site.com/webhook",
  "events": ["document.created", "document.updated"],
  "secret": "your-webhook-secret"
}

Webhook Payload #

json 
{
  "event": "document.created",
  "timestamp": "2024-01-15T10:30:00Z",
  "data": {
    "id": "uuid",
    "slug": "new-document",
    "title": "New Document Title"
  }
}

Signature Verification #

All webhooks are signed with HMAC-SHA256. Verify using:

javascript 
const crypto = require("crypto");
const signature = crypto
  .createHmac("sha256", secret)
  .update(payload)
  .digest("hex");

Compare with the X-Webhook-Signature header.

Source Attribution
OpenDocs keeps source fields explicit. Unknown values are labeled instead of invented.

Canonical source

Unknown

Original source

Unknown

Source domain

opendocs-core

Author

Unknown

Publisher

opendocs-core

License / usage

Unknown. Review the original source terms before republishing beyond public-safe excerpts.

Score
Version docs-phase3-2026-05-20
74

Overall quality score, confidence 71%

Source credibility50
Freshness92
Completeness68
Extraction quality85
Attribution confidence50
Readability
difficult | grade 20.6 | format 85

3 sentences, 5 headings, 5 list items.

Keep source attribution visible in the rendered document.

Search Appearance
canonical document page
OpenDocs keeps inspected URLs, canonical URLs, snippets, and rich-result signals explicit; Search Console metrics are not treated as visits.
Social Card
Webhooks Guide
Set up webhooks to get notified when documentation changes.
Duplicate State
No duplicate is asserted on this page without a matching canonical URL or content hash cluster.
Trace
docs-score-1ff4f269c9796e9566359b19
Export
Use public export endpoints for Markdown/JSON. Protected publishing still requires PLATPHORM_API_KEY.
webhookseventsnotificationsautomation

Related Documentation

πŸ’»πŸ–₯οΈπŸ”’πŸš€πŸ§ͺ

The difficulty of making sure your website is broken - Let's Encrypt

Have you ever needed to make sure your website has a broken certificate? While many tools exist to help run an HTTPS server with valid certificates, there aren’t tools to make sure your certificate is revoked or expired. This is not a problem most people have. Tools to help manage certificates are always focused on avoiding those problems, not creating them. Let’s Encrypt is a Certificate Authority, and so we have unusual problems we need to solve.

7 min read

⚑πŸ–₯οΈπŸ”’πŸ—οΈπŸ“°

What is JA4 and JA4+ Fingerprinting?

An overview of JA4 fingerprinting, a passive technique for combatting bots.

4 min read

πŸ“€πŸ“„βœ¨

Media Content

1 min read

πŸ”—πŸ“₯✨

URL Ingestion Guide

Learn how to ingest documentation from external URLs automatically.