Purpose

The primary objective of this guide is to provide a detailed, step-by-step approach to implementing the OHIP Streaming API.

It covers essential use cases, including:

Subscribing and Consuming Events: Learn how to establish a connection to the Streaming API, subscribe to specific business events, and process incoming data efficiently.

Replaying Events: Understand the mechanisms for replaying past events to ensure data consistency and recover from potential disruptions.

Receiving the Latest Event: Learn how and when to skip the queue to retrieve only the latest event.

This guide also provides best practices for scaling consumption, troubleshooting, and following OHIP workflows.

Note:

If you are automating integration, this guide provides message structures, parameter requirements, and step-by-step connection sequences. Note that some setup steps (such as environment enablement and application registration/approval) require manual action and cannot be performed solely via API requests.

• New to WebSockets