- OverOps Account
- xMatters account - If you don't have one, get one!
- OverOpsCommPlan.zip - Communications plan with inbound integration and message templates
xMatters set up
- Login to the xMatters instance as a developer and navigate to the Developer tab.
- Next to the OverOps communications plan, click Edit > Integration Builder and expand the Inbound Integrations.
- Click on the
Inbound from OverOpsscript and copy the inbound url at the bottom. Save this for later.
- Click on the Forms tab and under the
New Exceptionform click Edit > Layout. Enter the default recipients and click Save Changes. (An alternative to defaulting the recipients is to create a new Subscription Form)
OverOps set up
- Login to OverOps and click Settings > Alerts:
- Under one of the alerts, click the Send to entry and click Advanced Settings.
- Click the slider switch next to Webhook and paste in the url copied from the xMatters Comm Plan.
- Click Save & Finish.
If everything is correctly configured, then when an error is thrown by code that is watched by OverOps, the webhook will fire into the xMatters integration builder, the script will run and a new event will be created, targeting the default recipient and notifications will be sent out. There will be two response options:
- Acknowledge - Acknowledge the notification and stop device and group escalations
- Ignore - Ignore the notification and immediately escalate to the next recipient in the group.
The first step of troubleshooting would be to enable the Email notification type in the Alert. This will send an email as well as the webhook. If the code faults and no email is sent, then OverOps is not triggering the Alert.
If the email is sent, then investigate the Activity Stream in the Inbound Integration. If an entry corresponds with roughly the time the email from OverOps was sent, then check for any errors.
If there are no errors and an event was created then note the event ID and track down that event in the Event Report. The Event Log will have any other information about who was notified.