Welcome
Welcome to the Mambu Streaming API V2 Reference documentation!
The Streaming API allows you to subscribe to constant, real-time updates of activities within Mambu. If your connection is interrupted, your cursor position is saved so that when you reconnect, you will pick up exactly where you left off. The Streaming API is independent from the Mambu API and webhook infrastructure.
V2 covers the same core workflow as V1 (create a subscription, stream event batches, commit cursors), with a number of behavioral changes. If you have an existing V1 integration, start with Differences Between Streaming API V1 and V2.
Please note that this feature is an add-on feature and is not enabled for customers on our standard packages. For certain contracts concluded before 2021, this feature is limited to the Enterprise product tier. If you would like to request access to this feature, please get in touch with your Mambu Customer Success Manager to discuss your requirements.
For information about setting up event streaming notification templates in the Mambu UI, see Streaming API in our User Guide.
This API is distinct from the Streaming Publisher stats endpoint in the core v2 API, which exposes operational metrics about the publisher (for example, the number of undelivered events) rather than the event payloads themselves.
If you are looking for documentation for another API, you can use the Mambu APIs menu to view API Reference documentation for API v1, API v2, Streaming API V1, or Payments API. For more information about all the APIs we offer, see Mambu APIs in our User Guide.