Types · LitePush docs

BroadcastTarget

type

Broadcast audience selector passed to send().

{ type: "all" } | { type: "user"; external_id: string } | { type: "group"; group_id: string }

NotificationPayload

interface

The notification a broadcast renders in the browser.

Property	Type	Description
title	string	Title — visible to the user. 1–256 chars.
body	string	Body text. 1–2048 chars.
icon?	string	Small icon. Either an HTTPS URL (used as-is) or a base64 `data:image/*` URL (≤ 256 KB) the API hosts for you. Must be square (1:1). Available on every plan. Falls back to the project's default icon when omitted.
image?	string	Large banner image shown below the body on supported platforms. Same formats as `icon` (≤ 1 MB). Hobby plan and above only.
url?	string	URL opened on click. Defaults to `/` when omitted.

SubscribeOptions

interface

Property	Type	Description
userId?	string	Your own user ID — lets you target this user across devices in `send()` (`{ type: "user", external_id }`). May only contain letters, numbers, underscores, and hyphens (≤ 256 chars); `subscribe()` throws otherwise.

SubscribeResult

interface

Property	Type	Description
id	string	LitePush-assigned subscriber ID (`sub_*`).

Urgency

type

Web Push delivery priority hint (RFC 8030 Urgency header). The push service uses it to trade off battery vs. promptness: - very-low — deliver only when the device is plugged in and on Wi-Fi. - low — deliver when the device is active. - normal — the default. - high — wake the device promptly even when it's idle (e.g. a call, a code).

"very-low" | "low" | "normal" | "high"

CreateBroadcastParams

interface

Property	Type	Description
target	BroadcastTarget	—
notification	NotificationPayload	—
ttl?	number	How long (seconds) the push service keeps trying to deliver while the device is offline. `0` = deliver only if the device is connected right now. Defaults to 24 hours. Max 4 weeks (2,419,200). Available on every plan.
urgency?	Urgency	Delivery priority hint. Defaults to `normal`. Available on every plan.
topic?	string	Collapse key (≤ 32 URL-safe chars: `A–Z a–z 0–9 _ -`). A newer push with the same topic replaces an older, still-undelivered one in the gateway queue — so an offline device wakes to only the latest. Available on every plan.
scheduled_at?	number	Unix-ms timestamp to schedule the broadcast for a future time instead of sending now. Plus plan and above. Must be in the future, within 90 days.

CreateBroadcastResult

interface

Property	Type	Description
broadcast_id	string	—
scheduled_at?	number	Present only when the broadcast was scheduled.

Broadcast

interface

A broadcast as returned by broadcasts.get() / broadcasts.list().

Property	Type	Description
id	string	Broadcast id (`bdc_*`).
status	"pending" \| "sending" \| "sent" \| "failed" \| "canceled"	Lifecycle: `pending` (queued) → `sending` (fanning out) → `sent` (done) or `failed`. `canceled` for a scheduled broadcast cancelled before it fired.
source	"dashboard" \| "api"	Where it originated: the dashboard or the API.
target	BroadcastTarget	The audience it was sent to.
notification	{ title: string; body: string; icon: string \| null; image: string \| null; url: string \| null }	The notification content. `icon`/`image`/`url` are `null` when unset.
ttl	number \| null	Delivery options as sent. `null` = the default was used.
urgency	Urgency \| null	—
topic	string \| null	—
delivered_count	number	Pushes accepted by the push gateway.
failed_count	number	Pushes that failed (dead subscription, gateway error, retries exhausted).
scheduled_at	number \| null	Scheduled fire time (Unix ms), or `null` for an immediate send.
started_at	number \| null	When fan-out began (Unix ms), or `null` if it hasn't started.
finished_at	number \| null	When fan-out finished (Unix ms), or `null` if not done.
created_at	number	When the broadcast was created (Unix ms).

ListBroadcastsParams

interface

Property	Type	Description
limit?	number	Max rows to return. 1–100. Defaults to 20.
offset?	number	Rows to skip, for paging. Defaults to 0.

ListBroadcastsResult

interface

Property	Type	Description
broadcasts	Broadcast[]	This page of broadcasts, most recent first.
total	number	Total broadcasts in the project (ignores `limit`/`offset`).
limit	number	Echoes the effective `limit` / `offset` applied.
offset	number	—

MeResult

interface

Property	Type	Description
project	{ id: string; name: string; domain: string; vapid_public: string }	—

Group

interface

Property	Type	Description
id	string	—
name	string	—
description	string \| null	—
member_count	number	—
created_at	number	—

ListGroupsResult

interface

Property	Type	Description
groups	Group[]	—

CreateGroupParams

interface

Property	Type	Description
name	string	—
description?	string	—

CreateGroupResult

interface

Property	Type	Description
id	string	—

UpdateGroupParams

interface

Property	Type	Description
name?	string	—
description?	string \| null	Pass `null` to clear the description.

AddSubscribersResult

interface

Property	Type	Description
added	number	Count actually inserted — members already in the group don't double-count.

DeleteResult

interface

Property	Type	Description
deleted	number	Number of subscriber rows removed (`0` if nothing matched).

OkResult

interface

Property	Type	Description
ok	true	—

ApiErrorBody

interface

Shape of the API error envelope: { error: { code, message } }.

Property	Type	Description
error	{ code: string; message: string }	—