Node and Python

Each library is one call that wraps the HTTP API's bearer door, with no dependencies. The token is your source's ylk_…, from its page.

Node

Node 18 and up, Bun and Deno; the same package runs in React Native and Expo, since it uses the platform's fetch. ESM and CommonJS, with types.

$ npm install youlmk
import { notify } from "youlmk";
await notify(process.env.YOULMK_TOKEN, "deploy finished", {
body: "production · 4 min 12 s",
priority: "normal",
url: "https://example.com/deploys/2041",
});

For code that sends more than once, new YouLMK(token) keeps the token and .notify(title, options) sends. Options are the payload's fields in camelCase (urlLabel, fields, group, image, actions) plus idempotencyKey. The answer is { id, receipt, grouped, held }. An error is a YouLMKError with status, the door's code, the field for a 422 and retryAfter for a 429.

Python

Python 3.9 and up, the standard library only.

$ pip install youlmk
from youlmk import notify
notify(os.environ["YOULMK_TOKEN"], "backup finished", body="4.2 GB in 3 min 10 s", priority="low")

YouLMK(token).notify(title, ...) for more than one send. Keyword arguments are the payload's fields in snake_case (url_label, fields, group, image, actions) plus idempotency_key. The answer is a Result with id, receipt, grouped and held. An error is a YouLMKError with status, code, field and retry_after.

Which to use

A shell has curl and the command line. A server has these. An app you ship sends through its own server with one of these, or through a source whose Reach you are happy to let strangers reach, since a token inside an app is public.

Next

Payload reference · Swift, Kotlin and React Native · Command line