Introduction

Welcome. LitePush gives you the full Web Push stack — subscribe endpoint, VAPID keys, broadcast dashboard, delivery analytics, and webhook events — behind a drop-in <script> tag and a single API key.

If you've never sent a Web Push before, start with Getting started. If you already know the shape of Web Push and just want to wire it up, jump straight to the Browser SDK and REST API.

How these docs are organised

Use the sidebar to navigate. The docs are grouped into three areas:

• Guides — the conceptual overview and the five-minute setup guide.
  • Introduction — you are here.
  • Getting started — sign up, create a project, drop in the SDK, send your first push.
• API reference — the REST reference, one page per endpoint path.
  • Concepts — glossary, auth styles, error format, rate limits.
  • /v1/me, /v1/subscribe, /v1/unsubscribe, /v1/events, /v1/send, /v1/broadcasts, /v1/groups, /v1/subscribers — every endpoint, with all its methods.
  • Webhooks — the inbound event stream, HMAC-signed.
• SDK — the browser script and the npm package.
  • Script → Usage — the <script> drop-in: litepush.subscribe(), unsubscribe(), capability checks, the deferred-call queue.
  • Package → the @litepush/sdk npm package: Getting started, then the source-generated reference — Browser client, Server client, Types.

Need help?

Anything not covered here, email support@litepush.dev.