Skip to content

Latest commit

 

History

History
116 lines (104 loc) · 4.05 KB

pushsafer.md

File metadata and controls

116 lines (104 loc) · 4.05 KB
Raw
title description published date tags editor dateCreated
pushsafer
true
2023-03-17 18:57:54 UTC
markdown
2022-09-18 05:26:41 UTC

Notifiers > Pushsafer

Pushsafer is a part of the notifier plugin system. {.is-success}

This plugin provides the ability to send flexget notifications via the cross-platform notification system called Pushsafer.

Configuration

Option Type Description Default
private_key text Pushsafer's private or alias key. Required.
device text Target a specific device or device group id. blank
url URL Notification URL blank
url_title text Text to be displayed as URL title blank
sound numeric Override default notifcation sound. Must one of Pushsafer's supported sounds blank
icon numeric Override default notifcation icon. Must one of Pushsafer's supported icons 1 or blank
iconcolor text The icons color. Hexadecimal Colorcode, Example: #FF0000 blank
vibration numeric How often the device should vibrate (0-3) 0
priority numeric Notification priority, -2=lowest, -1=lower, 0=normal, 1=high, 2=highest (Critical Alerts) 0
time2live numeric Time in minutes, after which message automatically gets purged (0-43200) 0 or blank
retry numeric Time in seconds, after a message should resend (60-10800). 0 or blank
expire numeric Time in seconds, after the retry/resent should stop (60-10800). 0 or blank
confirm numeric Time in seconds after a message is resent before being confirmed (10-10800) 0 or blank
answer numeric 1 = Answer is possible, 0 = Answer is not possible. 0 or blank
answeroptions text predefined answer options divided by a pipe character e.g. Yes|No|Maybe blank
answerforce numeric Force Answer 1=yes 0=no 0 or blank

Examples

Examples show a specifc scenario usage of the notify plugin. See its wiki for a more detailed usage exaplantion.

Simple notification for each accepted entry

The simplest Pushsafer plugin configuration requires only the private key (private_key). This will broadcast the notification to all registered devices.

notify:
  entries:
    via:
      - pushsafer:
          private_key: PRIVATE_KEY

More advanced version

notify:
  entries:
    via:
      - pushsafer:
          private_key: o23ywmAaaxTYxn00jY2JAwQ2EeYXGt    
          device: 118
          url: http://server.example.com/path/to/downloader/ui
          url_title: Open Link
          sound: 12
          icon: 20
          iconcolor: #FF0000
          sound: 8
          vibration: 1
          priority: 2
          confirm: 10
          answer: 1
					answeroptions: yes|no|maybe
          answerforce: 1

Example with Jinja2 tags

notify:
  entries:
    title: >
      {%if task in ["task_a","task_b"](/"task_a","task_b")%} New movie added to queue
      {%else%}Download Started from task {{task}}
      {%endif%}
    message: >
      {% if series_name is defined %}{{series_name}} - {{series_id}} - {{trakt_ep_name}} - {{quality|d('')}}
      {% elif imdb_name is defined%}{{movie_name}} - {{quality}}
      {% else %}{{title}}
      {% endif %}
    via:
      - pushsafer:
          private_key: '{? credentials.pushsafer.private_key ?}'
          sound: 8
          icon: 20
          iconcolor: #00CC00
          vibration: 2
          priority: 2
          url: '{{trakt_series_trakt_url|d(imdb_url)}}'
          url_title: Link
					retry: 60
          expire: 600

Example with HTML tags

notify:
  entries:
    via:
      - pushsafer:
          private_key: '{? credentials.pushsafer.private_key ?}'
    message: |+
      [b]word[/b] - display word in bold
      [i]word[/i] - display word in italics
      [u]word[/u] - display word underlined
      [color=#FF0000>word[/color] - display word in red text (most colors and hex codes permitted)
      [url=https://www.pushsafer.com]Pushsafer[/url] - display word as a tappable link to https://www.pushsafer.com/