Noah Cloud supports two different type of Event Integrations:
Webhook (Events API)
If you prefer events to be pushed to you instead, we recommend using the HTTP-based Events API instead. and we'll deliver them with security, and We will even retry if things don't work out.
TODO: We have created a sample application that demonstrate how to create a WebHook receiver endpoint using ASP.NET, and the source code for the sample application is also available on GitHub.Real Time Messaging API (RTM API)
The Real Time Messaging API is a WebSocket-based API that allows you to receive events from Noah in real time. With the RTM API your app connects to Noah an receive events – this should only be used for supporting Real Time notifications to users to support the user experience. If your integration requires your app to receive all events you should use the Events API.
Subscribing to event types
On the App Portal under the "Event Subscriptions" configuration page you'll be able to select all the event types you want to subscribe to.
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 |