Endpoint Registry

Webhook Endpoints

Inspect the public-safe endpoint registry shell, validate receiver URL safety, and draft endpoint configuration before protected persistence.

Public-safe Work

  • Draft endpoint locally
  • Validate SSRF policy
  • Review signature and retry policy
  • Inspect redacted endpoint summaries

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/endpointsPOST /api/v1/endpoints protectedGET /api/v1/endpoints/{id}POST /api/v1/endpoints/{id}/test protected or dry-run local

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