Configuring alert settings

Configure the alert settings to control the aspects of the alerts that webMethods API Gateway sends when a request violates a rule.

About this task

Considerations when you configure alert settings.

  • Whether webMethods API Gateway issues an alert for a rule violation.
  • How often webMethods API Gateway issues the alert.
  • The method webMethods API Gateway uses to send the alert.
  • Whether a rule uses the default alert options or its own customized alert options.

Procedure

  1. Open the menu options and click Policies.
  2. Select Global Policies > Alert settings.
  3. Select one or both the alert destination types:
    • Email. It sends email alerts. Type the email ids to which the email must be sent.
    • Flow Service. It invokes a flow service to alert you of a rule violation. Specify the name of the flow service. You can create a flow service by using the pub.security.enterpriseGateway:alertSpec specification as the signature of the service or use the predefined flow service, pub.apigateway.threatProtection:violationListener. When you use the predefined service, the alerts are saved in the webMethods API Gateway Data Store and displayed webMethods API Gateway Dashboard. For more information on the pub.security.enterpriseGateway:alertSpec specification, refer to the Integration Server Build-In Services Reference Guide.

      Provide the user, who has permissions to run the service, as the user type. For example, Administrator.

  4. Select one of the conditions depending on when you want the alert to be sent such as:
    • On rule violation to send an alert every time a request violates a rule.
    • Every and specify the time interval \(in minutes\) to send alerts at specified intervals.
  5. Click Save.