Webhook Notifications Receiver
Description
This endpoint accepts webhook notifications from external systems. The target schema is explicitly provided in the request path as {schemaId}. The service retrieves the registered schema for the supplied identifier, validates the incoming payload against it, and asynchronously routes the event for downstream processing.
If the supplied schemaId is unknown, inactive, or not authorized for the calling client, an error response is returned. This ensures secure, structured, real-time event integration regardless of the use case. Notifications may include a wide range of business events such as file availability, status changes, or transactional updates.
Client webhooks are self-service. The client exposes a webhook endpoint that includes the structure of its requests. We examine this structure, derive the corresponding schema, generate a schemaId, and provide it to be passed as the path variable. Our notifications API is then registered with the client's webhook endpoint (via an internal API not exposed at the gateway), enabling incoming event delivery.
On receipt, the service:
- Validate the schemaId from the path and look up the registered schema.
- Validate the payload against the corresponding schema.
- Route the validated event asynchronously to the appropriate downstream workflow.
Client Benefits
- Secure, real-time communication between external systems and internal workflows.
- Simplifies event-driven automation by replacing manual checks or polling mechanisms.
- Can be reused across different clients and use cases with minimal configuration changes.
- Ensures secure, schema-based processing with full traceability for incoming events.
Data Availability
- Data in DEV/UAT may be purged periodically.
- Notifications are processed in near real time upon receipt.
- Schema-validated events are routed immediately for downstream processing.
- No persistent storage of incoming payloads unless implemented in downstream workflows.