Custom destination

You can configure custom destinations to publish events, performance metrics, and audit logs to a destination.

You can configure the following types of destinations by using the custom destinations feature:

  • External endpoint - Use this type to configure an external REST endpoint URL as a destination.
  • AWS Lambda - Use this type to configure an Amazon Web Services \(AWS\) Lambda function as a destination.
custom destination

Why Custom Destination?

webMethods API Gateway provides a set of destinations to which you can publish events to various components. Sometimes, customers need the data to be published to a custom destination. This data allows further data processing and the creation of various reports based on their business needs. The custom destination feature offers a solution to this requirement.

You can configure the custom destinations to publish either or the following list:

  • Design time events such as audit logs of webMethods API Gateway modules.
  • Destination-specific details such as error events and policy violation events of assets, and Performance metrics data.
  • Traffic monitoring payloads and alerts of an API

You can use custom destination feature to

Condition-based publishing

You can configure conditions based on which webMethods API Gateway filters events to publish to a configured destination. That is, only the events that satisfy your conditions are published to the destination. For example, you can configure a condition to publish the error events of the assets that satisfy your condition. This allows to filter data for a specific asset. As a result, you can handle use cases such as publishing API-level policy violation events to a REST endpoint, or sending API performance metrics to a messaging queue.

condition based publishing

To configure a condition, you can use variables available in the variable framework, and specify a matching value based on which the condition must be validated. You can specify multiple conditions and configure whether the data to be published must satisfy all or any of the conditions. The use cases in the section explain the process of configuring conditions.

Steps to configure a custom destination
  1. Provide custom destination name
  2. You can configure conditions to filter data which is optional.
  3. Then select Destination type and provide details.
  4. Publish the data.
    Note: You can configure any number of costume destination.