Distributed Cloud AIP Push Notification Integrations
Introduction
F5 Distributed Cloud App Infrastructure Protection (AIP) integrates with several third-party notification platforms to help users operationalize alert data in their existing workflows. Distributed Cloud AIP currently supports the following push notification platforms:
- PagerDuty
- Slack
- Slack for threatML
- VictorOps
- Webhook API
- Integration Status Webhook
Overview
Distributed Cloud AIP uses PagerDuty Connect to configure seamless PagerDuty integrations. As a result, the user selects the severity level of Distributed Cloud AIP alerts to push to PagerDuty. Any Distributed Cloud AIP alerts that match the selected severity level automatically push to PagerDuty and result in PagerDuty incidents and notifications.
Tip
As soon as Distributed Cloud AIP receives an alert that matches the push notification criteria, it pushes an alert notification to PagerDuty.
Prerequisites
- Access to the Distributed Cloud AIP console and ownership of the Distributed Cloud AIP organization
- A Basic, Standard, or Enterprise PagerDuty account with API access
Configure Integration within Distributed Cloud AIP
- Log into Distributed Cloud AIP.
- In the left navigation pane, click Settings.
- Click Integrations, then go to the PagerDuty section.
- In the PagerDuty section, click the Alert with PagerDuty button.
The PagerDuty Connect Distributed Cloud AIP and PagerDuty window opens.
- In the Email field, type your PagerDuty email address.
- In the Password field, type the password associated with the PagerDuty email address.
- Click the Sign In button. The window closes. Your return to the Distributed Cloud AIP Integrations page.
- In the PagerDuty section, from the Alert severity levels drop-down menu, select the severity level of alerts to push to PagerDuty. The PagerDuty integration is now live.
- Optionally, to test the integration, click the Trigger Test Alert button. When the user receives the PagerDuty notification, they can view details about the incident and/or click the View in Distributed Cloud AIP link to go directly to the Distributed Cloud AIP alert.
If you need assistance with your PagerDuty integration, then email us at aipsupport@f5.com.
Overview
Distributed Cloud AIP uses the Slack webhooks API to configure seamless Slack integrations. As a result, any Distributed Cloud AIP alerts that match the selected severity level automatically push as notifications to a selected Slack channel.
Tip
As soon as Distributed Cloud AIP receives an alert that matches the push notification criteria, it pushes an alert notification to Slack.
Important
The Slack webhooks API relies on rate limits when evaluating and responding to requests. Rate limits are defined by the features included in your Slack platform. If Distributed Cloud AIP receives a rate limiting response from Slack, then it will retry the request a limited number of times to prevent additional rate limiting. For additional information about rate limits, please review Slack Rate Limits.
Prerequisites
- Access to the Distributed Cloud AIP console
- A Slack administrator account with access to the Slack webhooks API
- A Slack channel dedicated to Distributed Cloud AIP alert notifications
Tip
Use side-by-side browser windows – one for Slack and one for Distributed Cloud AIP – to complete these instructions.
Configure Integration
Configure Custom Slack Webhook URL
- Log into Slack.
- In Slack, go to the Slack webhooks API.
- Click the Add Configuration button. The Incoming WebHooks page displays.
- From the Post to Channel drop-down menu, select the dedicated alert notifications channel.
- Click the Add Incoming WebHooks integration button. The Setup Instructions page displays.
- In the Webhook URL field, copy the URL.
Configure Distributed Cloud AIP Slack Integration
- Log into Distributed Cloud AIP.
- In the left navigation pane, click Settings.
- Click Integrations.
- Scroll to the Slack section.
- In the Name field, type a name for the integration.
- In the Description field, type a description of the integration.
- In the Webhook URL field, paste the URL copied in step 6 of the “Configure Custom Slack Webhook URL” procedure.
- From the Alert Severity drop-down menu, select the severity of the alert(s) to push to Slack.
- Click the Save button. The Slack integration is now live. The dedicated Slack alert notification channel contains an automated integration confirmation message.
Tip
Distributed Cloud AIP recommends intentionally causing an alert to test the Slack integration.
Overview
Distributed Cloud AIP uses the Slack webhooks API to configure a seamless Slack integration for threatML notifications. As a result, the daily threatML report will send a message to your selected Slack channel.
Prerequisites
- Access to the Distributed Cloud AIP console
- A Slack administrator account with access to the Slack webhooks API
- A Slack channel dedicated to Distributed Cloud AIP alert notifications
Tip
Use side-by-side browser windows – one for Slack and one for Distributed Cloud AIP – to complete these instructions.
Configure Integration
Configure Custom Slack Webhook URL
- Log into Slack.
- In Slack, go to the Slack webhooks API.
- Click the Add Configuration button. The Incoming WebHooks page displays.
- From the Post to Channel drop-down menu, select the dedicated alert notifications channel.
- Click the Add Incoming WebHooks integration button. The Setup Instructions page displays.
- In the Webhook URL field, copy the URL.
Configure Distributed Cloud AIP Slack Integration
- Log into Distributed Cloud AIP.
- In the left navigation pane, click Settings.
- Click Integrations.
- Scroll to the Slack ThreatML Daily Report section.
- On the Disabled slider bar, click the button. The slider bar now reads Enabled.
- In the Name field, type a name for the integration.
- In the Description field, type a description of the integration.
- In the URL field, paste the URL copied in step 6 of the “Configure Custom Slack Webhook URL” procedure.
- Click the Save button. The Slack integration is now live. The dedicated Slack alert notification channel contains an automated integration confirmation message.
Overview
Distributed Cloud AIP uses the VictorOps REST API to configure seamless VictorOps integrations. As a result, any Distributed Cloud AIP alerts that match the selected severity level automatically push as notifications to your selected VictorOps channel.
Tip
As soon as Distributed Cloud AIP receives an alert that matches the push notification criteria, it pushes an alert notification to VictorOps.
Prerequisites
- Access to the Distributed Cloud AIP console
- A VictorOps administrator account with access to the VictorOps REST API
Tip
Use side-by-side browser windows – one for VictorOps and one for Distributed Cloud AIP – to complete these instructions.
Configure Integration
Configure Custom VictorOps REST Endpoints
- Log into VictorOps.
- Go to Settings > Alert Behavior > Integrations.
The Integrations page displays.
- Scroll down the list of integrations and click Distributed Cloud AIP. The Distributed Cloud AIP page displays.
- Click the Enable Integration button. The integration enables.
- In the Service API Endpoint field, copy the URL up to
/$routing_key
.Note
The string of numbers and letters after
alert/
are unique to your account.
Configure Distributed Cloud AIP VictorOps Integration
- Log into Distributed Cloud AIP.
- In the left navigation pane, click Settings.
- Click Integrations.
- Scroll to the VictorOps section.
- In the Name field, type a name for the integration.
- In the Description field, type a description of the integration.
- In the Webhook URL field, paste the URL copied in step 5 of the “Configure Custom VictorOps REST Endpoint” procedure.
- From the Alert Severity drop-down menu, select the severity of the alert(s) to push to VictorOps.
- Click the Save button. The VictorOps integration is now live.
Overview
The Webhooks API pushes trigger-based alerts to a specific URL and allows Distributed Cloud AIP users to operationalize alert data in near-real time. The Webhooks API batches alerts by severity for an organization.
Tip
The Webhooks API pushes batched alerts to the your webhook endpoint every 10 seconds.
Prerequisites
- Access to the Distributed Cloud AIP console
- Access to a third-party integration in which to receive Distributed Cloud AIP alerts
Configure Integration
For configuration instructions, see Webhooks Setup.
Note
While the Webhooks API integrates with any third-party push notification application that supports webhooks, troubleshooting of those third-party integrations is the responsibility of the user, not Distributed Cloud AIP.
Overview
The Integration Status Webhook pushes notifications when AWS EC2 Correlation and / or AWS CloudTrail integration with Distributed Cloud AIP stops working. Each Distributed Cloud AIP organization includes one webhook for all of these notifications.
Note
If the AWS EC2 Correlation or AWS ClousTrail integration with Distributed Cloud AIP is disabled, then you do not receive a notification through the webhook.
Prerequisites
- Access to the Distributed Cloud AIP console and ownership of the Distributed Cloud AIP organization
- Access to the AWS Console
Configure Integration
- Log into Distributed Cloud AIP.
- In the left navigation pane, click Settings.
- Click Integrations.
- Scroll to the Integration Status Webhook section.
- Click the Disabled slider. The slider now reads Enabled.
- In the Name field, type a name for the integration.
- In the Description field, type a description of the integration.
- In the URL field, type the address to which you want to send the data.
- Click the Save button. The Integration Status Webhook integration is now live.