- 10 May 2023
- 3 Minutes to read
- Updated on 10 May 2023
- 3 Minutes to read
AlertOps and Confluence
AlertOps’ alert management system can be integrated with Confluence to receive and respond to all (predefined status mappings) alerts through email, SMS, push notification or phone alerts. AlertOps would ensure that the alert/job status would reach the appropriate team by using proper workflows, escalation policies and schedules. Based on your ruleset, incidents can be automatically opened and closed, depending on what event happens in Confluence (with respect to Pages, Users, Attachments, Blogs, Contents, Labels etc.)
The above scenario and scope for integration is due to the fact that AlertOps has a very flexible and simple API/Webhook configuration feature that can be leveraged with Confluence's notification plugin feature.
AlertOps - Inbound Integration
We can define rulesets in AlertOps so that Confluence can send out event alerts to the AlertOps platform. AlertOps would ensure based on these notifications received, that it would always reach out and assign to the correct person/team by utilizing its escalation policies, schedules, and workflow features.
AlertOps provides Inbound Integrations to integrate with numerous monitoring, chat and ITSM tools. You can configure an inbound integration for Confluence.
At a high level this is how the flow looks like, you define an API integration in the AlertOps platform by defining settings like Integration Name, Escalation rules, recipient users/groups. Once an integration is defined, a unique API URL is generated. This acts as webhook or the gateway through which notifications from Confluence reach AlertOps and thus an incident/alert is created correspondingly. The API can be defined with various settings like URL mappings, filters, escalations etc. as required. Confluence has to be setup with a Webhook plugin and configured with events for triggers.
This guide serves to send alerts for 'Page' updates, this can be modified for any event
Configure Inbound Integration in AlertOps
- Under 'Configuration' select 'Integrations'. From the Inbound Integration section, select 'API' from the dropdown and then click the 'Add API' button.
- Select Confluence from the list of available integration options.
- Once you select the integration, you can then specify basic settings like the integration name, escalation policy, names of the recipients/groups for which the alerts must be assigned to.
- Once you click save, the API Integration will be created, and you will be given a unique URL which acts as the access point and needs to be configured at the source (in this case Confluence), to send alerts. You can find the integration you just created, and you can give advanced settings and define various configurations for the alerts to be received and processed. For example, you can define when to open and close alerts based on the payload obtained from the API call, filters etc.
- Make a note of the API URL, which will be used in Confluence, so it calls a HTTP POST request to this URL with the body in JSON format containing the alert specific information. AlertOps automatically creates an alert when the status variable (eventType) contains 'page_created/page_restored/page_updated'. The incident will also be closed automatically when the status 'page_removed/page_trashed' is received from Confluence. The above mapping to open and close alerts is for Confluence Page based events, this can be modified based on the payload that you receive for any component (Example: Users, Content, attachments, labels etc.)
- You can similarly define URL mappings as you want, owing to the flexibility provided by AlertOps’ OpenAPI/Plug-and-Play integrations. You can provide other filters and match with regex expressions as well. You can also test the generated URL with the sample data provided.
Configure Integration in Confluence
- Go to your Confluence Portal, in the top right corner select the 'Settings' gear icon.
- Under Atlassian Marketplace, select Find New Apps. Search for 'Webhook Manager for Confluence Cloud'
- Add and install the app. This might take a few minutes.
- Once this is done you should have the option 'Webhooks' under Atlassian Marketplace
- Select 'Webhooks', click 'Add Webhook'. Give the Webhook a name, enable the Status toggle and paste the AlertOps Inbound API integration URL in the URL field.
- Under Event types, select the following (in the screenshot below). You can select other events as well as you wish and map it accordingly in AlertOps.
- Save it.
Thats it! You have configured a Webhook Notification plugin for Page events. Any alert would now be sent to AlertOps for incident management.
Message logs, alert specific information can be viewed in the “Inbound Log” section in AlertOps Dashboard. Alerts can be viewed in the ‘Alerts’ tab as well.
Alert Triggering Information
AlertOps will automatically create an incident when a new alert is received from Confluence when the eventType field contains 'page_created/page_restored/page_updated'.
If an alert with status 'page_created/page_restored/page_updated' matches an existing Open Alert, AlertOps will recognize the new alert as a duplicate and ignore the alert.
The alert will be recorded in the Inbound Messages table as “Mapped Appended.”
AlertOps will automatically close the same incident when an alert with eventType contains 'page_removed/page_trashed'.