For Experienced WebSocket/GraphQL Developers

OHIP vs. Standard GraphQL Subscriptions:

• Subscription URL Structure: WebSocket endpoint expects hashed application key as a query parameter.
• Authentication: Uses OAuth bearer token in connection_init payload.
• Subscription Approval: Environment owner approval in the OHIP Developer Portal is mandatory before events are streamed.
• Single-Consumer Constraint: Only one active subscriber per app key/chain/gateway in order to retain the sequence of events; parallel clients result in disconnects (4409 error) unlike typical broadcast models or multi-consumer pub/sub.
• Replay: Events can be replayed using a textual offset (not numeric).
• Event Structure: Subscriptions expose both "full event" and "delta" modes.
• Termination: Do not manually close the socket after sending complete; wait for server closure.
• Versioning and Major Changes: If the Streaming API schema changes in a breaking way, Oracle will communicate this via a Major Change announcement. For more information, see Versioning in the Oracle Hospitality Integration Platform User Guide.

In summary, the OHIP Streaming API is versatile and can be applied to various scenarios within the hospitality sector. The following topics cover three primary use cases:

• Subscribing and Consuming Events
• Replaying Events
• Receiving the Latest Event