{"id":20357855,"url":"https://github.com/gandi/hubot-pager-v2","last_synced_at":"2025-04-12T03:14:42.502Z","repository":{"id":57269173,"uuid":"71397929","full_name":"Gandi/hubot-pager-v2","owner":"Gandi","description":"Pagerduty (APIv2) plugin for Hubot.","archived":false,"fork":false,"pushed_at":"2023-01-03T07:13:33.000Z","size":234,"stargazers_count":6,"open_issues_count":0,"forks_count":6,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-03-25T22:51:27.305Z","etag":null,"topics":["chatbot","coffeescript","hubot","pagerduty"],"latest_commit_sha":null,"homepage":null,"language":"CoffeeScript","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/Gandi.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2016-10-19T20:48:41.000Z","updated_at":"2023-03-17T02:59:20.000Z","dependencies_parsed_at":"2023-02-01T05:31:10.706Z","dependency_job_id":null,"html_url":"https://github.com/Gandi/hubot-pager-v2","commit_stats":null,"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Gandi%2Fhubot-pager-v2","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Gandi%2Fhubot-pager-v2/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Gandi%2Fhubot-pager-v2/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Gandi%2Fhubot-pager-v2/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Gandi","download_url":"https://codeload.github.com/Gandi/hubot-pager-v2/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248173846,"owners_count":21059595,"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":["chatbot","coffeescript","hubot","pagerduty"],"created_at":"2024-11-14T23:24:09.849Z","updated_at":"2025-04-12T03:14:42.485Z","avatar_url":"https://github.com/Gandi.png","language":"CoffeeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Hubot-pager-v2 and v3 webhooks\n==================\n\n[![Version](https://img.shields.io/npm/v/hubot-pager-v2.svg)](https://www.npmjs.com/package/hubot-pager-v2)\n[![Downloads](https://img.shields.io/npm/dt/hubot-pager-v2.svg)](https://www.npmjs.com/package/hubot-pager-v2)\n[![Build Status](https://img.shields.io/travis/Gandi/hubot-pager-v2.svg)](https://travis-ci.org/Gandi/hubot-pager-v2)\n[![Dependency Status](https://gemnasium.com/Gandi/hubot-pager-v2.svg)](https://gemnasium.com/Gandi/hubot-pager-v2)\n[![Coverage Status](http://img.shields.io/codeclimate/coverage/github/Gandi/hubot-pager-v2.svg)](https://codeclimate.com/github/Gandi/hubot-pager-v2/coverage)\n\nThis plugin is based on the usage we have in Gandi of Pagerduty. It may, in its first instance, not match your setup, so please verify that first.\n\n- we have on main schedule that is for the general alert dispatch (`PAGERV2_SCHEDULE_ID`)\n- only one person is on call at any given time\n- we don't use teams\n\nV3 Webhooks Subscriptions\n-----------\nWe have added support to V3 Subscriptions, [follow the official guide](https://support.pagerduty.com/docs/webhooks#migrating-from-v1v2-generic-extensions-to-v3-webhook-subscriptions) for more information about how to migrate from Webhooks V1/V2 to V3.\n\n\nConfiguration\n---------------\n\n    # pager v2 configuration vars\n    export PAGERV2_API_KEY=\"\"\n    export PAGERV2_SCHEDULE_ID=\"\"\n    export PAGERV2_SERVICES=\"name1,name2\"\n    export PAGERV2_DEFAULT_RESOLVER=\"nagios\"\n    export PAGERV2_ENDPOINT=\"/hook\"\n    export PAGERV2_ANNOUNCE_ROOM=\"#dev\"\n    export PAGERV2_NEED_GROUP_AUTH=\"0\"\n    export PAGERV2_LOG_PATH=\"/tmp\"\n    export PAGERV2_CUSTOM_ACTION_FILE=\"file.json\"\n\n\nPAGERV2_API_KEY contains the pagerduty api key for v2 api.\nPAGERV2_SCHEDULE_ID contains the default schedule for oncall and override\nPAGERV2_SERVICES contains the name of the service, separated by comma, of the service to monitor/interact with\nPAGERV2_DEFAULT_RESOLVER=\"nagios\" in case no resolver is found, use this one\nPAGERV2_ENDPOINT=\"/hook\" the path used to setup the webhook. be sure it is not already in use.\nPAGERV2_ANNOUNCE_ROOM=\"#dev\" where to announce webhook message\nPAGERV2_NEED_GROUP_AUTH=\"0\" if weither or not (0,1) you need authentication for interacting with pagerduty\nPAGERV2_LOG_PATH=\"/tmp\" where to save the log of pager\nPAGERV2_CUSTOM_ACTION_FILE=\"file.json\" this contains the custom action binding in the form { action_id : { action : 'action_name', args : {...} } } The action name refer to an available command from this module or another (will do a robot.emit action_id.action action_id.args)\n\n\n\nUsage\n--------\n\nIn the while, `hubot help pager` should list you all available commands.\n=======\nyou can use `hubot help pager` to list all available commands :\n\n    .pager \u003cuser\u003e as \u003cemail\u003e   - declare what email should be use to find \u003cuser\u003e pagerduty id\n    .pager [who is] next [oncall] - tells who is next on call\n    .pager [who is] oncall        - tells who is currently on call\n    .pager ack \u003c#,#,#\u003e         - acknowledges incident \u003cnumber\u003e\n    .pager ack [all]           - acknowledges any unack incidents\n    .pager assign \u003c#,#,#\u003e to \u003cuser\u003e - assigns incidents \u003c#,#,#\u003e to user\n    .pager assign \u003c#,#,#\u003e to me     - assigns incidents \u003c#,#,#\u003e to caller\n    .pager assign [all] to \u003cuser\u003e   - assigns all open incidents to user\n    .pager assign [all] to me       - assigns all open incidents to caller\n    .pager end \u003cmaintenance\u003e - ends \u003cmaintenance\u003e\n    .pager incident \u003c#\u003e        - gives more information about incident number \u003cnumber\u003e\n    .pager maintenances           - lists currently active maintenances\n    .pager extensions [name]   - list extensions filtered by name. relevant for custom_action\n    .pager me                  - check if the caller is known by pagerduty plugin\n    .pager me \u003cduration\u003e       - creates an override for \u003cduration\u003e minutes\n    .pager me as \u003cemail\u003e       - declare what email should be use to find caller pagerduty id\n    .pager me next             - creates an override for the next scheduled\n    .pager me now              - creates an override until the end of current oncall\n    .pager noc \u003cduration\u003e      - creates an override for \u003cduration\u003e minutes with the noc account\n    .pager noc now             - creates a noc override until the end of current oncall\n    .pager not me              - cancels an override if any\n    .pager not noc             - cancels a noc override if any\n    .pager note \u003c#,#,#\u003e \u003cnote\u003e - create a note for incidents \u003c#,#,#\u003e\n    .pager notes \u003c#\u003e           - read notes for incident \u003c#\u003e\n    .pager oncall \u003cmessage\u003e       - cc oncall and send \u003cmessage\u003e to alerting channel\n    .pager res|resolve \u003c#,#,#\u003e - resolves incident \u003cnumber\u003e\n    .pager res|resolve [all]   - resolves any un-resolved incidents\n    .pager snooze \u003c#,#,#\u003e [for] [\u003cduration\u003e] [min] - snoozes incident \u003cnumber\u003e\n    .pager snooze [all] [for] [\u003cduration\u003e] [min]   - snoozes any open incidents for [\u003cduration\u003e] (default 120m)\n    .pager stfu|down \u003cservice,service,service\u003e for \u003cduration\u003e [because \u003creason\u003e] - creates a maintenance per service\n    .pager stfu|down [for] \u003cduration\u003e [because \u003creason\u003e] - creates a maintenance\n    .pager sup|inc|incidents   - lists currently unresolved incidents\n    .pager version             - give the version of hubot-pager-v2 loaded\n    .pager who is \u003cuser\u003e       - check if the caller is known by pagerduty plugin \n\nDevelopment\n--------------\n\n### Changelog\n\nAll changes are listed in the [CHANGELOG](CHANGELOG.md)\n\n### Testing\n\n    npm install\n\n    # will run make test and coffeelint\n    npm test \n    \n    # or\n    make test\n    \n    # or, for watch-mode\n    make test-w\n\n    # or for more documentation-style output\n    make test-spec\n\n    # and to generate coverage\n    make test-cov\n\n    # and to run the lint\n    make lint\n\n    # run the lint and the coverage\n    make\n\n\n### Contribute\n\nFeel free to open a PR if you find any bug, typo, want to improve documentation, or think about a new feature. \n\nGandi loves Free and Open Source Software. This project is used internally at Gandi but external contributions are **very welcome**. \n\nAttribution\n-----------\n\n### Authors\n\n- [@mose](https://github.com/mose) - author\n- [@baptistem](https://github.com/baptistem) - author and maintainer\n- [@araujobsd](https://github.com/araujobsd) - contributor\n\n### License\n\nThis source code is available under [MIT license](LICENSE).\n\n### Copyright\n\nCopyright (c) 2016-2023 - Gandi - https://gandi.net\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgandi%2Fhubot-pager-v2","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgandi%2Fhubot-pager-v2","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgandi%2Fhubot-pager-v2/lists"}