README.md

No longer maintained

We no longer use this project, and it no longer works out of the box due to Slack renaming the "channels" APIs to "conversations". It could serve as an idea for how to implement a bot like this, though as the original author I'd advise against copying its code exactly (pre-TypeScript JS written using lots of Promises but no async/await).

Old README

This bot maintains a single Slack channel's topic to contain the name of the level-1 on-call user for a given PagerDuty schedule ID.

Create a settings.json file like:

{
  "pagerduty": {
    "schedules": [{
      "label": "Primary",
      "id": "ID",
      "slackUserGroupHandle": "oncall-primary"
    }, {
      "label": "Secondary",
      "id": "ID"
    }],
    "pagerdutyToken": "TOKEN"
  },
  "slack": {
    "channels": [{
      "name": "engine-alerts",
      "pattern": "P: @(Primary), S: @(Secondary)"
    }, {
      "name": "engine-alerts-discuss",
      "pattern": "P: @(Primary), S: @(Secondary)"
    }],
    "slackToken": "TOKEN1",
    "slackAdminToken": "TOKEN2",
    "users": {
      "glasser@meteor.com": "U02FWGZ19"
    },
    "combinedUserGroupHandle": "oncall"
  },
  "intervalMS": 30000
}

• In PagerDuty
  • Log in as an Admin-role user
  • Configuration -> API Access
  • Create New API Key
  • Make it a V2 Current token, Read-only.
  • Copy the token value into the pagerduty.pagerdutyToken settings field
  • Navigate to the page for the schedule(s) you want to monitor. Its URL is something like https://meteorjs.pagerduty.com/schedules#PTJS3I9 Copy the final bit (PTJS3I9) to the pagerduty.schdules.id settings fields
• In Slack
  • Register an app at https://api.slack.com/apps
  • Select Permissions and add:
    • channels:read
    • channels:write
    • users:read
    • usergroups:read
    • usergroups:write
  • Click "Install App To Team" and select the appropriate team
  • This provides an Access Token. Copy it into the slack.slackToken settings field
  • Also copy the "signing secret" from the Basic Information page into the slack.signingSecret settings field
  • Now get a Slack team admin to follow the same steps (aside from the signing secret part), but with only the permission users.profile:write. Put its Access Token into slack.slackAdminToken. This is used to set the status emoji and text for arbitrary users. (Note: if any of the users in slack.users are themselves admins, it appears that this token needs to come from a Primary User, not just an Admin.)

Users listed (by Slack ID) in the slack.users section will have their status text and emoji set as configured when they are on call, and cleared if they are not on call any more and their status starts with 'On call!'. (If they already have a status, it is appended to the 'On call!' status text along with its emoji, and restored when they go off call.) The email listed must match the email stored in PagerDuty. They will also be added to any Slack user group named in slackUserGroupHandle.

The simplest way to find a Slack ID is to run users.list via the Slack API tester and find the id field corresponding to the user.

Deploy to Galaxy. (This is deployed to galaxy-primary-oncall-bot.meteorapp.com.)