solarOSsolarOS Docs
Api

Webhook endpoints are managed from Settings → Integrations → Webhooks, not through the Org API (Org API keys create the domain events that eligible webhook subscriptions receive, but don't manage endpoint config). Per apps/web/src/lib/org-api/public-docs.ts's webhooks content: each delivery POSTs JSON with id, type, apiVersion, organizationId, requestId, occurredAt, actor, data, changedFieldPaths, and context; deliveries are signed (X-SolarOS-Signature: v1=<hex hmac> over timestamp.rawBody) and retried with exponential backoff (1 minute up to 1 hour, 8 attempts) on 429/5xx/timeout/network errors. Payload retention is 30 days, response-body retention is 7 days. See the generated webhook events reference for the exact event/wildcard list.

TODO(owner, likely integrations): write the full page. It can be lifted almost directly from apps/web/src/lib/org-api/public-docs.ts's WEBHOOKS_PAGE constant (event catalog, payload shape, signing and verification, retry behavior, retention and replay, management in Settings), reformatted with this site's worked-example style and a signing verification code sample.

Was this page helpful?