Integration
Docs Handoff
Publish delivery reports, contract remediation notes, and incident docs. Current status is degraded; protected publishing requires PLATPHORM_API_KEY, while public requests return local/degraded evidence only.
Public-safe Work
- create_docs_report
- Publish delivery reports, contract remediation notes, and incident docs.
- Access: protected
- Status: degraded
Protected Boundary
Persistent mutation, third-party delivery, raw private detail, replay, cancel, publish, and sync actions require PLATPHORM_API_KEY.
Authorization: Bearer $PLATPHORM_API_KEY
X-PlatPhorm-API-Key: $PLATPHORM_API_KEYAPI Surface
GET /api/v1/integrations/docsPOST /api/v1/integrations/docs/create-docs-report where implementedLifecycle Context
1. Define event type
Name the event, version it, and wrap it in the PlatPhorm event envelope.
2. Define event contract
Attach JSON Schema or an AsyncAPI-compatible event contract before delivery.
3. Register endpoint
Validate endpoint URLs with SSRF protection; server persistence is protected.
4. Generate payload
Create a positive sample, negative sample, or local event payload from a template.
5. Sign payload
Build the canonical string and HMAC header without storing the raw secret.
6. Send event
Protected sends create an event, delivery, async job, attempt, and trace-linked evidence.
platphormctl
platphormctl site inspect webhooksplatphormctl mcp validate webhooksplatphormctl policy inspect webhooksplatphormctl webhooks events