How it works
When a problem meets a specified threshold in Sentry, it sends a JSON-formatted webhook to xMatters. A Sentry trigger in xMatters parses the webhook and initiates a flow. The webhook includes essential alert data that is included in notifications sent to users, and details about the origin of the alert that you can use to enrich the notifications or use when building automated tasks.
Here's how to install the Sentry workflow through the xMatters one-click installation process.
- Go to the Workflows Templates page and click the Sentry tile.
- On the Install Workflow dialog box, give the workflow a name (this must be unique in your instance) and add an optional description.
- You can edit these later, if needed.
- Click Install.
- After the workflow installs, the screen shows next steps as well the installation logs. The installation logs give you additional information about the installation, such as if you have languages in your instance that aren't configured for the messages in the workflow.
- Copy the trigger URL — you’ll use this to configure a webhook in Sentry.
- The trigger URL includes the recipients parameter, which specifies who should be notified. By default, this parameter is set to notify you (the logged in user), but you can set it to target any user or group you want.
- Click Open Workflow.
Configure Sentry to send requests to the trigger URL
To have Sentry send alerts to the flow trigger, you need to add a Metric Alert Rule to Sentry that targets the trigger URL.
A paid Sentry account is required to complete these steps.
- In Sentry, go to Settings > Developer Settings.
- Click New Internal Integration.
- Complete the following fields:
- Name: Webhook
- Webhook URL: Paste the xMatters trigger URL you copied previously. Add the target names of any recipients you want xMatters to notify when the alert fires.
- For example, if you want to notify Emma Pearson, Mary McBride, and the on-call members in the Monitor Team responsible for the service, you'd add ?recipients=epearson,mmcbride,monitor%20team to the URL.
- You must URL-encode any special characters or spaces in the target names.
- Alert Rule Action: On
- Click Save.
Next, you'll need to create an alert on an existing project.
- Select the project you want to create an alert on.
- Click Create Alert.
- Select Metric Alert.
- If required, adjust the query.
- Click Add Action and select the following from the drop-down menus:
- Critical Status: xMatters (Internal)
- Warning Status:xMatters (Internal)
- Click Save.
You're ready to use the webhook to trigger automated flows, including steps such as sending alerts and initiating incidents, though we always recommend testing before putting things into use.
The trigger expects the recipients in the trigger URL. When you copy the URL from xMatters, it includes the recipients parameter: recipients=<yourname>. Of course, you don’t want to receive all the alerts.
To change the recipients for alerts from this webhook, swap out your name for the people or groups you want to target. For example, to target the 'DatabaseTeam', 'Antares Service Team', and 'HR & Marketing' groups, add recipients=databaseteam,antares%20service%20team,HR%20%26%20Marketing to the trigger URL. Remember to URL-encode any special characters, including spaces, in your group names.
When a condition you've set fires, it sends a signal to xMatters, which creates an event and notifies the individual or the on-call members of the people or groups you set as recipients in the webhook URL. When the trigger receives a signal saying the issue is resolved, it automatically terminates related events in xMatters.
The person responding to the notification has the following response options:
- Acknowledge: Acknowledges the notifications and stops escalations.
- Escalate: Immediately escalates the event to the next on-call resolver in a targeted group.
- Close: Ends the xMatters event and stops notifying all targeted recipients.
- Initiate Incident: Initiates an incident in xMatters.
Now that you've installed the Sentry workflow, you can use it as-is, or customize it to suit your needs better. Here are some examples of things you can add to the workflow to customize it:
- Use Slack, Zoom, and Microsoft Teams steps to add collaboration channels to the flow.
- Change the severity of incidents created when a recipient selects the Initiate Incident response.
- Update the message sent to resolvers to include the information most relevant to your team.
- Use the Sentry Alerts trigger to build your own custom flows.