Skip to main content
You can call the Notealy public API with plain fetch / curl — but for production integrations we recommend reaching for the official SDK. It handles auth, retries on 429/5xx, error mapping, and typed request payloads so a server-side change surfaces as a compile error instead of a runtime surprise.

TypeScript / JavaScript

npm Works on Node 18+, Bun, Deno, and the browser. Zero runtime dependencies — uses native fetch.

Hello, world

Cover map

Error handling

Non-2xx responses become NotealyApiError with status, code, message, parsed body, and requestId (when the server sets the X-Request-Id header).
The client retries 429 (honoring X-RateLimit-Reset) and 5xx responses automatically. Override the policy or disable it per call:

Webhooks

Verify the signature on every delivery — the SDK ships the same HMAC formula the API uses to sign:
Always pass the raw body string — re-stringifying after JSON.parse breaks the signature. See Webhooks → Signing for detail.

Python and Go

In progress. We’re validating the TypeScript surface with the first integrators; Python (httpx + pydantic) and Go (oapi-codegen + stdlib http) follow once that’s stable. Ping us at hello@notealy.com if you need either before then.