{"id":15602467,"url":"https://github.com/fiveisprime/statuspage-notifier","last_synced_at":"2025-03-29T13:24:36.021Z","repository":{"id":33448939,"uuid":"37094325","full_name":"fiveisprime/statuspage-notifier","owner":"fiveisprime","description":"Notifier for statuspage.io.","archived":false,"fork":false,"pushed_at":"2015-08-30T00:51:59.000Z","size":176,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-04T14:21:32.357Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://npm.im/statuspage-notifier","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fiveisprime.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-06-08T21:37:47.000Z","updated_at":"2015-07-06T14:50:24.000Z","dependencies_parsed_at":"2022-09-18T22:23:24.012Z","dependency_job_id":null,"html_url":"https://github.com/fiveisprime/statuspage-notifier","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fiveisprime%2Fstatuspage-notifier","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fiveisprime%2Fstatuspage-notifier/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fiveisprime%2Fstatuspage-notifier/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fiveisprime%2Fstatuspage-notifier/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fiveisprime","download_url":"https://codeload.github.com/fiveisprime/statuspage-notifier/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246188679,"owners_count":20737746,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-03T02:41:37.494Z","updated_at":"2025-03-29T13:24:36.000Z","avatar_url":"https://github.com/fiveisprime.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# statuspage-notifier\n\n[![npm version](https://badge.fury.io/js/statuspage-notifier.svg)](http://badge.fury.io/js/statuspage-notifier) [![Code Climate](https://codeclimate.com/github/fiveisprime/statuspage-notifier/badges/gpa.svg)](https://codeclimate.com/github/fiveisprime/statuspage-notifier) [![Test Coverage](https://codeclimate.com/github/fiveisprime/statuspage-notifier/badges/coverage.svg)](https://codeclimate.com/github/fiveisprime/statuspage-notifier/coverage)\n\nSupply the publicly accessible status URL for your statuspage.io account, the\ninterval at which to check, and the contents of your package.json.\n\n# Usage\n\nInitialize the notifier with the following options\n\n*`name`*: Name of your service. This will be output as the header for the status\n\n*`checkInterval`*: Minimum time between displaying the status\n\n*`apiUrl`*: URL of your statuspage API\n\n*`pageUrl`*: URL of your statuspage page\n\n\n```js\nvar notifier = require('statuspage-notifier')({\n  name          : 'My API',\n  checkInterval : 1 * 60 * 1000, // Will only run and output once per hour.\n  apiUrl        : 'http://yzskf90qzqff.statuspage.io/api/v2/status.json',\n  pageUrl       : 'http://status.modulus.io'\n});\n\n// Call the notify method as much as you like, the request and output will\n// only happen ater the specified internval has elapsed.\nnotifier.notify();\n```\n\n*Example Output*\n\n```shell\n--------------------------------------------------\nModulus status\n--------------------------------------------------\nWeb Interface:       operational\nAPI:                 operational\nMongoDB:             operational\nBalancers:           degraded performance\nStats:               operational\nApplication Hosts:   operational\n--------------------------------------------------\nThere is 1 open incident\nAWS us-east-1a balancer 54.236.216.66 under heavy load\n--------------------------------------------------\nView full details at http://status.modulus.io\n```\n\nHaving trouble finding the API URL for your statuspage? Go to `/api` to see the\ndocumentation and URL for your service. :)\n\nSpecial thanks go to [Francesca Varney](https://github.com/franvarney) for\nwriting the initial version of the status check.\n\n# License\n\nThe MIT License (MIT)\n\nCopyright (c) 2015 Matt Hernandez\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffiveisprime%2Fstatuspage-notifier","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffiveisprime%2Fstatuspage-notifier","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffiveisprime%2Fstatuspage-notifier/lists"}