Contract Registry

Webhook Contracts

Validate payloads against JSON Schema, generate positive and negative samples, and hand contract evidence to Spec, Evals, or Sandbox.

Public-safe Work

  • Validate pasted schema and payload
  • Generate sample payload
  • Generate negative test payload
  • Export Markdown or JSON evidence

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_KEY

API Surface

GET /api/v1/contractsPOST /api/v1/contracts protected or local draftPOST /api/v1/contracts/validatePOST /api/v1/contracts/{id}/validatePOST /api/v1/contracts/{id}/generate-payloadPOST /api/v1/contracts/{id}/generate-negative-payload

Lifecycle 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 webhooks
platphormctl mcp validate webhooks
platphormctl policy inspect webhooks
platphormctl webhooks events