extern/apprise
1
0
Fork 0
mirror of https://github.com/caronc/apprise.git synced 2024-12-04 05:54:35 +01:00
Code Issues Packages Projects Releases Wiki Activity
Page: Notify_notica
Pages
CLI_Usage DemoPlugin_Basic DemoPlugin_WebRequest Development_API Development_Apprise_Details Development_Contribution Development_LogCapture Home Notification_Graveyard Notify_Custom_Form Notify_Custom_JSON Notify_Custom_XML Notify_Revolt Notify_africas_talking Notify_apprise_api Notify_aprs Notify_bark Notify_boxcar Notify_bulksms Notify_bulkvs Notify_burst_sms Notify_chantify Notify_clicksend Notify_d7networks Notify_dapnet Notify_dbus Notify_dingtalk Notify_discord Notify_email Fastmail Notify_email Notify_emby Notify_enigma2 Notify_faast Notify_fcm Notify_feishu Notify_flock Notify_freemobile Notify_gitter Notify_gnome Notify_googlechat Notify_gotify Notify_growl Notify_guilded Notify_homeassistant Notify_httpsms Notify_ifttt Notify_join Notify_kavenegar Notify_kodi Notify_kumulos Notify_lametric Notify_line Notify_lunasea Notify_macosx Notify_mailgun Notify_mastodon Notify_matrix Notify_mattermost Notify_messagebird Notify_misskey Notify_mqtt Notify_msg91 Notify_msteams Notify_nexmo Notify_nextcloud Notify_nextcloudtalk Notify_notica Notify_notifiarr Notify_notifico Notify_ntfy Notify_office365 Notify_onesignal Notify_opsgenie Notify_pagerduty Notify_pagertree Notify_parseplatform Notify_plivo Notify_popcornnotify Notify_prowl Notify_pushalot Notify_pushbullet Notify_pushdeer Notify_pushed Notify_pushjet Notify_pushme Notify_pushover Notify_pushsafer Notify_pushy Notify_reddit Notify_rocketchat Notify_rsyslog Notify_ryver Notify_sendgrid Notify_serverchan Notify_ses Notify_seven Notify_sfr Notify_signal Notify_simplepush Notify_sinch Notify_slack Notify_sms_manager Notify_smseagle Notify_smtp2go Notify_sns Notify_sparkpost Notify_splunk Notify_spontit Notify_streamlabs Notify_stride Notify_synology_chat Notify_syslog Notify_techulus Notify_telegram Notify_threema Notify_toasty Notify_twilio Notify_twist Notify_twitter Notify_voipms Notify_wecombot Notify_whatsapp Notify_windows Notify_workflows Notify_wxpusher Notify_wxteams Notify_xbmc Notify_xmpp Notify_zulip Sponsors Troubleshooting URLBasics config config_text config_yaml decorator_notify persistent_storage showcase
4 Notify_notica
Chris Caron edited this page 2023-02-13 22:28:26 -05:00
Table of Contents

Notica Notifications

  • Source: https://notica.us/
  • Icon Support: No
  • Message Format: Text
  • Message Limit: 32768 Characters per message

Account Setup

Notica doesn't require you to create an account at all. You just have to visit their website at least once to both:

  1. Get your token
  2. Enable Browser Notifications (to be sent from the Notica website)

The website will generate you a URL to post to that looks like this: https://notica.us/?abc123

This effectively equates to: https://notica.us/?{token} Note: disregard the question mark on the URL as it is not part of the token.

From here you have two options, you can directly pass the Notica URL into apprise exactly how it is shown to you from the website, or you can reconstruct the URL into an Apprised based one (which equates to slightly faster load times) as: notica://{token}

Syntax

Valid syntaxes are as follows:

  • https://notica.us/?{token}
  • notica://{token}

For self hosted solutions, you can use the following:

  • notica://{host}/{token}
  • notica://{host}:{port}/{token}
  • notica://{user}@{host}/{token}
  • notica://{user}@{host}:{port}/{token}
  • notica://{user}:{password}@{host}/{token}
  • notica://{user}:{password}@{host}:{port}/{token}

Parameter Breakdown

Variable Required Description
token Yes The Token that was generated for you after visiting their website. Alternatively this should be the token used by your self hosted solution.

A self hosted solution allows for a few more parameters:

Variable Required Description
hostname Yes The Web Server's hostname.
port No The port our Web server is listening on. By default the port is 80 for xml:// and 443 for all xmls:// references.
user No If you're system is set up to use HTTP-AUTH, you can provide username for authentication to it.
password No If you're system is set up to use HTTP-AUTH, you can provide password for authentication to it.

Example

Send a notica notification:

# Assuming our {token} is abc123

apprise -vv -t "Test Message Title" -b "Test Message Body" \
   notica://abc123

Header Manipulation

Self-hosted solutions may require users to set special HTTP headers when they post their data to their server. This can be accomplished by just sticking a hyphen (-) in front of any parameter you specify on your URL string.

# Below would set the header:
#    X-Token: abcdefg
#
# Assuming our {hostname} is localhost
# Assuming our {token} is abc123
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   "notica://localhost/abc123/?-X-Token=abcdefg"

# Multiple headers just require more entries defined with a hyphen in front:
# Below would set the headers:
#    X-Token: abcdefg
#    X-Apprise: is great
#
# Assuming our {hostname} is localhost
# Assuming our {token} is abc123
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   "notica://localhost/abc123/?-X-Token=abcdefg&-X-Apprise=is%20great"

Quick Links: