Getting Started
Let's start with an overview of the Event API:
- An
Eventrepresents an action or a change that took place within the Recuro Health platform. - A
Subscriberrepresents a collection of subscriptions. - A
Subscriptionis a request to be notified of a specific type of event that has taken place and where that notification should be sent. - An event
Typerepresents a very specific action or change, such as a member updating their profile.
Webhooks
When an event occurs, Recuro Health makes an HTTP POST request to the URL you configured for the webhook. Recuro Health's request will include details of the event such as the member ID number or the body of a profile change.
To handle a webhook you only need to build a small web application that can accept the HTTP requests. If you already have a web application set up, handling a webhook is usually as easy as adding a new URL to your application.
Delivery and Retry
Recuro Health waits 30 seconds for a response after delivering a message. After 30 seconds, if the endpoint hasn't responded, the message is queued for retry. Recuro Health uses an exponential backoff retry policy for message delivery. Recuro Health retries delivery on the following schedule on a best effort basis:
- 10 seconds
- 30 seconds
- 1 minute
- 5 minutes
- 10 minutes
- 30 minutes
- 1 hours
- Hourly for up to 24 hours
Delivery Status
Recuro Health uses HTTP response codes to acknowledge receipt of events.
Success Codes
Recuro Health considers only the following HTTP response codes as successful deliveries. All other status codes are considered failed deliveries and will be retried as appropriate. Upon receiving a successful status code, Recuro Health considers delivery complete.
- 200 OK
- 201 Created
- 202 Accepted
- 203 Non-Authoritative Information
- 204 No Content
Delivery Order
While rare, Recuro Health does not guarantee that events will always be sent or received in the order in which they occurred. It is the responsibility of your application to account for this if there is a scenario in which ordering is required. Ordering can be managed by evaluating the following attributes together:
- Time
- Id
- Type
Integration Methods
The Event API is accessible by referencing the REST API directly or by using a Recuro Health SDK. To get started, choose an option below.
Updated 7 months ago
Choose an option to get started
