https://github.com/vend/phoneduty

Twilio/PagerDuty integration to forward inbound calls to the currently on-call engineer
https://github.com/vend/phoneduty

backstage-exclude

Last synced: 6 days ago
JSON representation

Twilio/PagerDuty integration to forward inbound calls to the currently on-call engineer

• Host: GitHub
• URL: https://github.com/vend/phoneduty
• Owner: vend
• License: mit
• Created: 2014-08-11T05:54:32.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2024-01-10T03:04:53.000Z (about 1 year ago)
• Last Synced: 2024-04-15T01:15:33.495Z (10 months ago)
• Topics: backstage-exclude
• Language: PHP
• Homepage:
• Size: 22.5 KB
• Stars: 26
• Watchers: 6
• Forks: 35
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Phoneduty

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/vend/phoneduty/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/vend/phoneduty/?branch=master)

[![Build Status](https://scrutinizer-ci.com/g/vend/phoneduty/badges/build.png?b=master)](https://scrutinizer-ci.com/g/vend/phoneduty/build-status/master)

[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)

This is a Twilio Twimlet designed to be hosted on Heroku. It will query PagerDuty to find the currently on-call engineer and forward the inbound call to them.

It needs a few environment variables defined to work:

    PAGERDUTY_SCHEDULE_ID

    PAGERDUTY_API_TOKEN

    PAGERDUTY_DOMAIN

Those names should be fairly self-explanatory. The domain is the piece of your PagerDuty URL that is specific to you 

i.e.  https://[PAGERDUTY_DOMAIN].pagerduty.com/

You can also optionally set PHONEDUTY_ANNOUNCE_TIME, which if set to a TRUEish value will include the current

time of the engineer being called as part of the answering message. This may help raise awareness that you are potentially getting

somebody out of bed, so be gentle :D

# Usage

- Configure your on-call schedule in PagerDuty

- Ensure your rostered staff have a 'phone' contact method defined

- Note the schedule ID of the roster you wish to use.

- Create and note an API key in PagerDuty

- Deploy this app to Heroku.

- Configure the relevant environment variables above in Heroku

- Buy a phone number from Twilio

- Add the generated Heroku URL  as a "Request URL" for the Voice property of this Twilio number

- Call the external Twilio number. You should get a voice prompt telling you who is on call, what time it is in their timezone currently, and then you will get connected to the rostered engineer.

# Relevant Reading

## Twilio

Twilio TwiML reference

Some sample Twimlets:

## PagerDuty 

PagerDuty API 

## Heroku

Setting up and deploying PHP apps on Heroku