axonpush
API reference

API reference

The axonpush HTTP API — publish events, manage channels, apps and keys, read traces and analytics. Every endpoint, grouped by resource.

The axonpush REST API is what every SDK talks to. You can call it directly with any HTTP client; the pages below document each endpoint with request and response schemas and a live “try it” panel.

Most applications should use a client SDK rather than raw HTTP — see the Python SDK and TypeScript SDK. The SDKs handle auth headers, retries, fail-open behaviour and content redaction for you.

Base URL

https://api.axonpush.xyz

Self-host deployments serve the same API from their own API domain — point AXONPUSH_BASE_URL (or baseUrl) at it.

Authentication

Send a server API key in the X-API-Key header, and your organisation UUID in X-Tenant-Id (keys are scoped to an org, app and environment):

curl -X POST https://api.axonpush.xyz/event \
  -H "X-API-Key: $AXONPUSH_API_KEY" \
  -H "X-Tenant-Id: $AXONPUSH_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{"channelId": "<channel-id>", "identifier": "hello", "payload": {"ok": true}}'

Dashboard and operator endpoints instead accept a session Bearer JWT.

Endpoints