[{"_1":2,"_179":-5,"_180":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_158":159},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_88":89,"_109":110,"_147":-5,"_148":11,"_149":21,"_150":11,"_151":-5,"_152":11,"_153":-5,"_154":155,"_156":111,"_157":-7},"canonicalUrl","https://hub.docker.com/r/seecloud/notify/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","seecloud","reponame","notify","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":74,"_79":21,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2016-12-06T08:10:25.901336Z","description","Notify service","is_private","last_updated","2016-12-31T00:28:07.524936Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",250,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","Notification as a Service\n=========================\n\nThe service is a simple gateway that delivers notifications via configured backends.\n\n.. contents::\n\nNotification drivers\n--------------------\n\nNotification driver is a python code that knows how to send message to specific target.\n\nFor example, there is a driver named *dummy_pass* - this means that python module\n*notify/drivers/dummy_pass.py* must exist and has class *Driver* properly implemented:\n\n.. code::\n\n >>> from notify import driver\n >>> from notify.drivers import dummy_pass\n >>> issubclass(dummy_pass.Driver, driver.Driver)\n True\n\nSince it is convenient to have ability to send message to several targets by single API call, the service actually operates with groups of drivers called *backends*.\n\nNotification backends\n---------------------\n\nBackend is simple named group of notification drivers.\n\nThey configured in `notify_backends <#id1>`_ section of configuration file.\n\nHow to configure\n----------------\n\nConfiguration file is specified via *NOTIFY_CONF* environment variable\nand consists of these main parts: **flask**, **backend** and **notify_backends**.\n\nflask\n~~~~~\n\nSection *flask* contains configuration for Flask application as described on\n`official documentation `_.\n\nThe only extra options are **HOST** and **PORT**.\n\nbackend\n~~~~~~~~\n\nConnection parameters to data storage.\nNot in use currently, so this section can be omitted. \n\nnotify_backends\n~~~~~~~~~~~~~~~\n\nThis is the most important configuration section, since it describes notification backends.\n\nEach configured backend groups some drivers with proper configuration.\n\nThe structure is the following:\n\n.. code::\n\n {\n : {\n : { driver configuration parameters },\n : { driver configuration parameters }\n },\n ...\n }\n\nBackend name can be arbitrary and affects only API calls where it is explicitly specified.\n\nFor example, there is a backend *foo* with drivers *bar* and *spam*:\n\n.. code::\n\n \"notify_backends\": {\n \"foo\": {\n \"bar\": {\"key\": \"value\"},\n \"spam\": {\"quiz\": 42}\n }\n }\n\nSo if there is an API call *POST /api/v1/notify/foo* with specific message in request body, then this message will be sent by drivers *bar* and *spam*.\n\nconfiguration example\n~~~~~~~~~~~~~~~~~~~~~\n\nHere is a simple configuration file example with `dummy drivers <#id2>`_ grouped into 3 backends:\n\n.. code::\n\n {\n \"flask\": {\n \"PORT\": 5000,\n \"HOST\": \"0.0.0.0\"\n },\n \"notify_backends\": {\n \"dummy\": {\n \"dummy_pass\": {},\n \"dummy_fail\": {}\n },\n \"dummy-rnd\": {\n \"dummy_random\": {\"probability\": 0.5}\n },\n \"dummy-err\": {\n \"dummy_err\": {},\n \"dummy_err_explained\": {}\n }\n }\n }\n\nHow to run\n----------\n\nInitially, let's download and install the service into virtualenv:\n\n.. code::\n\n $ virtualenv notify_env\n $ . notify_env/bin/activate\n $ git clone https://github.com/seecloud/notify/\n $ cd notify\n $ pip install -r requirements.txt\n\nNow save configuration file (given above) as *config.json* and set proper env variable to its path:\n\n.. code::\n\n export NOTIFY_CONF=$(pwd)/config.json\n\nFinally, start the service (at http://localhost:5000):\n\n.. code::\n\n $ python notify/main.py\n\nHow to test\n-----------\n\nWhen started, service provides RESTful API for notifications.\nLet's use `CURL `_ command line utility for convenience.\n\nDummy drivers\n~~~~~~~~~~~~~\n\nDummy drivers are always available and are ready for use immediately,\nhowever they do not actually send alerts.\n\nThese drivers are suitable for demonstrations and smoke testing.\n\nSince the configuration already uses dummy drivers, let's see how this works.\n\nThere is an API call to all configured backends *dummy*, *dummy-rnd* and *dummy-err*:\n\n.. code::\n\n $ curl -XPOST -H 'Content-Type: application/json' http://localhost:5000/api/v1/notify/dummy,dummy-rnd,dummy-err -d '\n {\n \"region\": \"farfaraway\",\n \"description\": \"This is a dummy payload, just for testing.\",\n \"severity\": \"INFO\",\n \"who\": \"JohnDoe\",\n \"what\": \"Hooray!\"\n }'\n\nThe response contains results from all 5 dummy drivers:\n\n.. code::\n\n {\n \"errors\": 2,\n \"failed\": 1,\n \"passed\": 2,\n \"payload\": {\n \"description\": \"This is a dummy payload, just for testing.\",\n \"region\": \"farfaraway\",\n \"severity\": \"INFO\",\n \"what\": \"Hooray!\",\n \"who\": \"JohnDoe\"\n },\n \"result\": {\n \"dummy\": {\n \"dummy_fail\": {\n \"status\": false\n },\n \"dummy_pass\": {\n \"status\": true\n }\n },\n \"dummy-err\": {\n \"dummy_err\": {\n \"error\": \"Something has went wrong!\"\n },\n \"dummy_err_explained\": {\n \"error\": \"This error message must appear in API response!\"\n }\n },\n \"dummy-rnd\": {\n \"dummy_random\": {\n \"status\": true\n }\n }\n },\n \"total\": 5\n }\n\nSFDC driver\n~~~~~~~~~~~\n\nThere is a *SFDC* driver which transfers notifications to `SalesForce `_ customers.\n\nLet's configure backend and send notification to SalesForce.\n\n**NOTE: To get started with this, obtain proper SFDC OAuth2 credentials.**\n\nCreate a *config.json* file with the content, having all values filled with proper credentials:\n\n.. code::\n\n {\n \"flask\": {\n \"PORT\": 5000,\n \"HOST\": \"0.0.0.0\"\n },\n \"notify_backends\": {\n \"sf\": {\n \"sfdc\": {\n \"auth_url\": \"https://.salesforce.com\",\n \"username\": \"\",\n \"password\": \"\",\n \"organization_id\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\"\n }\n }\n }\n }\n\nIf not already done, set proper env variable to *config.json* path:\n\n.. code::\n\n export NOTIFY_CONF=$(pwd)/config.json\n\nNow send notification to the service with the following command.\nDo not forget to specify proper environment in place of **:\n\n.. code::\n\n $ curl -XPOST -H 'Content-Type: application/json' localhost:5000/api/v1/notify/sf -d '\n {\n \"region\": \"\",\n \"description\": \"This is a dummy payload, just for testing.\",\n \"severity\": \"INFO\",\n \"who\": \"JohnDoe\",\n \"what\": \"Hooray!\"\n }\n '\n\nThe response includes *\"status\": true* so the notification is successful:\n\n.. code::\n\n {\n \"errors\": 0,\n \"failed\": 0,\n \"passed\": 1,\n \"payload\": {\n \"description\": \"This is a dummy payload, just for testing.\",\n \"region\": \"\",\n \"severity\": \"INFO\",\n \"what\": \"Hooray!\",\n \"who\": \"JohnDoe\"\n },\n \"result\": {\n \"sf\": {\n \"sfdc\": {\n \"status\": true\n }\n }\n },\n \"total\": 1\n }\n","has_starred","hub_user","immutable_tags_settings",{"_75":11,"_76":77},"enabled","rules",[78],".*","is_automated","permissions",{"_82":21,"_83":11,"_84":11},"read","write","admin","user","storage_size",3105680660,"orgData",{"_90":91,"_92":93,"_94":95,"_96":33,"_97":98,"_99":98,"_100":101,"_102":98,"_103":104,"_105":98,"_106":98,"_107":98,"_108":21},"id","9a1899ba1c214f9686f3cc1a2b4f7bf6","uuid","9a1899ba-1c21-4f96-86f3-cc1a2b4f7bf6","type","organization","orgname","full_name","","location","company","Mirantis","profile_url","date_joined","2016-10-10T22:09:57.087288Z","gravatar_url","gravatar_email","badge","is_active","recentTags",[111],{"_112":44,"_113":114,"_115":116,"_90":117,"_118":119,"_50":136,"_137":114,"_138":33,"_139":56,"_57":140,"_141":142,"_143":127,"_144":136,"_145":66,"_146":21},"content_type","creator",1162846,"full_size",200040875,6615996,"images",[120],{"_121":122,"_123":124,"_125":98,"_126":127,"_128":129,"_130":131,"_132":98,"_133":-5,"_134":116,"_63":66,"_135":-5},"architecture","amd64","digest","sha256:5eb700870e02ecf79b10928f9574b7b4fbe5da53f92ac49fff7b4a4de727face","features","last_pulled","2026-09-21T22:23:06.415001491Z","last_pushed","2016-12-31T00:28:08Z","os","linux","os_features","os_version","size","variant","2016-12-31T00:28:07.181282Z","last_updater","last_updater_username","media_type","latest","repository",1094724,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":160,"_167":168,"_154":177,"_178":11},{"_40":161,"_42":162,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":163,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":164,"_79":21,"_80":166,"_85":33,"_86":87},[],[44],[56],{"_75":11,"_76":165},[78],{"_82":21,"_83":11,"_84":11},"tags",{"_169":64,"_170":-5,"_171":-5,"_172":173},"count","next","previous","results",[174],{"_112":44,"_113":114,"_115":116,"_90":117,"_118":175,"_50":136,"_137":114,"_138":33,"_139":56,"_57":140,"_141":142,"_143":127,"_144":136,"_145":66,"_146":21},[176],{"_121":122,"_123":124,"_125":98,"_126":127,"_128":129,"_130":131,"_132":98,"_133":-5,"_134":116,"_63":66,"_135":-5},[],"canDeleteTags","actionData","errors"]

seecloud/notify

Tags for seecloud/notify