Webhook Management in Microservice API Gateway

Resolve Bottlenecks,
Find Innovative Solutions
Generate Solutions

Solution Overview

Problem

In microservice architecture networks, existing systems face inefficiencies due to duplication of efforts and code across multiple APIs handling common functionalities, leading to increased complexity and resource utilization when managing events and configurations.

Innovation Solution

A distributed API gateway architecture is implemented, where common functionalities are bundled into a gateway node that connects multiple APIs, using plugins and a control plane to configure event hooks, allowing for centralized management and automatic action upon specific events.

Engineering Contradictions & Design Principles

VSEngineering Contradiction Analysis

1Adaptability or versatility

If multiple APIs handle common functionalities independently, then each API can be developed and deployed autonomously, but duplication of code and efforts increases complexity and resource utilization

Engineering Contradiction:
Improveautonomous development and deploymentVSAvoidcode duplication and system complexity
Core Design Contradiction:
Adaptability or versatilityVSDevice complexity

Solution Approach 1:

The patent merges common functionalities into a shared webhook management system that multiple APIs can utilize. Instead of each API implementing event handling independently, they converge on a common webhook configuration and management infrastructure, reducing code duplication while preserving autonomous deployment capabilities through the microservice architecture.

Inventive Principle:
Principle #5Merging (Combining)

Solution Approach 2:

The webhook management system is designed as a universal component that serves multiple APIs simultaneously. It provides common event handling, configuration management, and plugin execution capabilities that can be reused across different APIs, eliminating the need for each API to implement its own duplicate functionality.

Inventive Principle:
Principle #6Universality (Multi-functionality)

2Reliability

If a system monitors multiple microservices for event tracking, then system security and proper routing can be ensured, but resource utilization and management complexity increase

Engineering Contradiction:
Improvesystem security and routing accuracyVSAvoidmonitoring system complexity
Core Design Contradiction:
ReliabilityVSDevice complexity

Solution Approach 1:

The patent introduces a webhook management system as an intermediary layer between microservices and event handlers. This mediator centralizes the monitoring and event tracking functionality, reducing the complexity distributed across multiple services while maintaining security and routing accuracy through unified management.

Inventive Principle:
Principle #24Intermediary (Mediator)

Solution Approach 2:

The monitoring and event tracking functionality is extracted from individual microservices and consolidated into a dedicated webhook management system. This separation allows microservices to focus on their core functions while the extracted monitoring system handles security, routing, and event tracking centrally.

Inventive Principle:
Principle #2Taking out (Extraction)

3Adaptability or versatility

If plugins are added to latency-sensitive routes for enhanced functionality, then system capabilities are improved, but latency and processing time increase

Engineering Contradiction:
Improvesystem functionalityVSAvoidrouting latency
Core Design Contradiction:
Adaptability or versatilityVSSpeed

Solution Approach 1:

The system applies plugins selectively based on route characteristics and event types. Not all routes receive all plugins; instead, plugins are applied only where necessary to achieve the desired functionality while minimizing latency impact. This partial application strategy balances enhanced capabilities with performance requirements.

Inventive Principle:
Principle #16Partial or excessive action

Solution Approach 2:

Webhook configurations and plugin registrations are performed in advance during system initialization or configuration phases. This preliminary setup allows the system to have pre-configured event handlers ready, reducing the overhead during actual event processing and minimizing latency during runtime operations.

Inventive Principle:
Principle #10Preliminary action

Data Source

PatentUS11954539B1Webhooks use for a microservice architecture application
Publication Date: 2024.04.09 KONG INC
  • US11954539B1 patent drawing
  • US11954539B1 patent drawing
  • US11954539B1 patent drawing

AI summary

Disclosed embodiments are directed at systems, methods, and architecture for configuring event hooks in a microservice architecture-based system. The control plane links a plurality of APIs for a microservice architecture application. Each API includes a data plane proxy that serves traffic for the API from the control plane. The control plane receives an event hook including an event, a source, and a handler. The control plane configures a component of the microservice-architecture-based system to run the handler when the event occurs at the source. When the event occurred at the source, the component runs the handler.