Custom Destination
You can configure custom destinations to publish events, performance metrics, and audit logs to a required destination.
You can configure the following four types of destinations using the custom destinations feature:
External endpointUse this type to configure an external REST endpoint URL as a destination.
webMethods IS service Use this type to configure a webMethods IS service as a destination.
AWS Lambda Use this type to configure an Amazon Web Services (AWS) Lambda function as a destination.
Messaging Use this type to configure a message queue as a destination. Messaging systems can read the message from the queue or topic and process it asynchronously.
Why Custom Destination?
API Gateway provides options to publish events and logs to preset destinations. But sometimes customer might require the data to be published to a custom destination for further data processing and for generating various reports as per their business requirements. The custom destination feature offers solution to this requirement.
You can configure custom destinations to publish either or all of the following:
Design time events such as audit logs of API Gateway modules.
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 perform:
Condition-based publishing
You can configure conditions based on which API Gateway filters events to publish to a configured destination. That is, only the events that satisfy your conditions are published to the given destination. For example, you can configure a condition to publish the error events of an application, say app1, to a destination; and another condition to publish the error events of another application, app2, to a second destination and so on.
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 given conditions. The use cases in this section explain the process of configuring conditions.
Steps to configure a custom destination
The following diagram outlines the steps involved in configuring a custom destination:
You can configure any number of custom destinations.
