Overview

The Webhook Publisher API is a high-availability notification service designed to synchronize data between BMG Money and partner ecosystems in real-time. By utilizing a push-based model, it eliminates the need for constant polling, ensuring your system is updated the moment a business event occurs.

1. Technical Requirements

All requests must be authenticated via OAuth 2.0 and include context-aware headers to ensure strict data isolation between employers/tenants.

Authentication and Headers

Header Type Required Description
Authorization String Yes Bearer Token (OAuth 2.0).
X-Context-Entity String Yes The entity type (e.g., Employer).
X-Context-Key String Yes The unique identifier for the context (e.g., Employer ID).
X-Products Array No Optional filter for product-specific events.