Noah Cloud supports two different type of Event Integrations:
Real Time Messaging API (RTM API)
The Real Time Messaging API is SignalR based that allows you to receive events from Noah in real time. With the RTM API your app connects to Noah and receive events – this should only be used for supporting Real Time notifications to users to support the user experience. SignalR includes retry functionality. If your integration requires your app to receive all events - even those generated while your app is not running - you should use the Events API to be able to catch up. Data is not encrypted, but contains only ids enabling you to look up the actual data via the API.Webhook (Events API)
If real time delivery is not a requirement and you need to receive all events, even those generated while your app is not running, we recommend using the HTTP-based Events API instead and we'll deliver them encrypted. We will even retry if things don't work out.
Subscribing to event types
You can set up events via the API.
Important!:
Your Request URL might receive many events and requests. Consider decoupling your ingestion of events from the processing and reaction to them.See main page about choosing event integration and to learn about general concepts: Event Integrations
Connecting
Connect to the /rtm path on the API URL.
Invoke the hub method “SubscribeTenant” method with tenant id and event subscription id
Listen for events on the “OnEvent” hub method
When disconnecting, invoke the hub method “LeaveTenant”
Suggested client: SignalR
We suggest using SignalR which handles retries etc. It is also able to fall back to other transports if necessary.
RtmClient.NET API Client
| Info |
|---|
To download and use the HIMSA supplied RTM client add the following URL to your nuget package sources: For more information on adding new package sources and installing nuget packages visit https://learn.microsoft.com/en-us/nuget/consume-packages/install-use-packages-visual-studio |