YouLMK Notifications
Account Setup
Section titled “Account Setup”YouLMK is a hosted notification inbox. Any HTTP client can send it a message. For each sender (a source), you choose its reach (Silent, Badge, Banner, or Break through), whether it respects quiet hours, and how repeated messages are grouped. Notifications can arrive on your phone, in your browser, by email, in Slack, or through your own webhook.
- Sign in at youlmk.com or in the app and create a source for the sender (for example,
apprise). Every source has its own key and rules. - Open the source’s Key screen. Either credential shown there works:
- the bearer token,
ylk_followed by 32 characters - the URL key,
k_followed by 14 characters
- the bearer token,
The trial includes 10 notifications and 3 watches without a credit card. Afterward, Send costs $4 per month.
Syntax
Section titled “Syntax”Valid syntax is as follows:
https://youlmk.com/k/{key}youlmk://{token}youlmk://{key}youlmk://{token}?priority={priority}youlmk://{token}?info={priority}&success={priority}&warning={priority}&failure={priority}youlmk://{token}?url={link}&url_label={label}&group={group}
The priority may be forced for every notification with ?priority=, or set per Apprise notification type with ?info=, ?success=, ?warning= and ?failure=. When omitted, it is derived from the notification type:
| Apprise Type | YouLMK Priority |
|---|---|
info | normal |
success | normal |
warning | high |
failure | high |
critical is never a default: it may break through quiet hours and Focus when the source allows it, so it is opted into. The source’s Reach stays the ceiling; a priority only moves down from it.
Parameter Breakdown
Section titled “Parameter Breakdown”| Variable | Required | Description |
|---|---|---|
| token | *Yes | The source’s bearer token (ylk_ and 32 characters) or its URL key (k_ and 14 characters). It may also be supplied as a ?token= query argument. |
| priority | No | Forces this priority for every notification: low, normal, high or critical. Short-forms work too (e.g. crit). |
| info / success / warning / failure | No | Override the priority used for that notification type (defaults: normal / normal / high / high). e.g. ?info=low&failure=critical. |
| url | No | The address behind the notification’s primary button, for example the run or the log it is about. |
| url_label | No | The wording on that button, up to 24 characters. Anything longer is trimmed. YouLMK writes Open when this is left out. |
| group | No | Notifications with the same group within ten minutes become one card with a count. Defaults to the title. |
| image | No | Set to yes to put Apprise’s notification-type image on the card in place of your source’s own icon. Defaults to no. |
Global Parameters
Section titled “Global Parameters”| Variable | Description |
|---|---|
| overflow | Controls messages that exceed a service’s documented limit. The default is upstream.👉 upstream: Send one message without splitting or truncating it for that limit.👉 truncate: Keep the portion that fits and discard the rest.👉 split: Prefer a readable break, fall back to a hard boundary, and send every part in order.Splitting undeclared or structured content is best effort. Use upstream when the body must remain one intact document. |
| format | This parameter can be set to either text, html, or markdown. Some services support the ability to post content by several different means. The default of this varies (it can be one of the 3 mentioned at any time depending on which service you choose). You can optionally force this setting to stray from the defaults if you wish. If the service doesn’t support different types of transmission formats, then this field is ignored. |
| verify | External requests made to secure locations (such as through the use of https) will have certificates associated with them. By default, Apprise will verify that these certificates are valid; if they are not then no notification will be sent to the source. In some occasions, a user might not have a certificate authority to verify the key against or they trust the source; in this case you will want to set this flag to no. By default it is set to yes. |
| redirect | By default, Apprise will follow HTTP redirects (3xx responses) issued by the remote server, matching the behaviour of the underlying requests library. If you want to prevent custom headers and credentials from being forwarded to destinations that differ from the original URL, set this to no. By default it is set to yes. |
| cto | This stands for Socket Connect Timeout. This is the number of seconds Requests will wait for your client to establish a connection to a remote machine (corresponding to the connect()) call on the socket. The default value is 4.0 seconds. |
| rto | This stands for Socket Read Timeout. This is the number of seconds the client will wait for the server to send a response. The default value is 4.0 seconds. |
| emojis | Enable Emoji support (such as providing :+1: would translate to 👍). By default this is set to no. Note: Depending on server side settings, the administrator has the power to disable emoji support at a global level; but default this is not the case. |
| tz | Identify the IANA Time Zone Database you wish to operate as. By default this is detected based on the configuration the server hosting Apprise is running on. You can set this to things like America/Toronto, or any other properly formated Timezone describing your area. |
| retry | The number of additional delivery attempts to make after the first failure before giving up. Accepts an integer in the range 0 to 10. The default is 0 (no retries — a single attempt is made). When combined with wait, Apprise pauses the specified number of seconds between each attempt. |
| wait | The number of seconds to pause between retry attempts. Accepts a decimal value in the range 0.0 to 20.0; integer values are promoted to float automatically. The default is 0.5. This value is only meaningful when retry is greater than zero — a service with retry=0 makes exactly one attempt regardless of the wait value. |
| optional | When set to yes, a delivery failure for this service is silently absorbed. The overall notify() call still evaluates as true even if this endpoint was unreachable, provided that every required (non-optional) service in the same batch succeeded. Setting this flag does not skip delivery or bypass retry logic — all configured retry attempts are still made before the failure is absorbed. By default this is set to no, meaning every failure is propagated to the caller. |
Examples
Section titled “Examples”Send a notification:
apprise -vv -t "Backup finished" -b "4.2 GB in 3 min 10 s" \ "youlmk://ylk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"The same with the URL key:
apprise -vv -t "Backup finished" -b "4.2 GB in 3 min 10 s" \ "youlmk://k_xxxxxxxxxxxxxx"Make every failure critical, with a labelled link to the log:
apprise -vv -n failure -t "Backup failed" -b "exit 2" \ "youlmk://ylk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx?failure=critical&url=https://example.com/logs/2041&url_label=View%20log"Example YAML configuration:
urls: - youlmk://ylk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx?failure=critical - youlmk://k_xxxxxxxxxxxxxx?priority=low&group=nightly&image=yes Questions or Feedback?
Technical Issues
Having trouble with the code? Open an issue on GitHub: