Skip to content

Webhooks

In order for your system to receive webhooks, you need to setup a valid URL here. Note that the API needs to be enabled in order to be able to receive webhooks.

Here are the requirements for this URL:

  1. This URL must be able to accept POST requests.
  2. Its recommended that this URL has a token as a route parameter or a query string parameter. We may add support to specify basic authentication credentials for your endpoint at some point in the future.
  3. The webhook request will timeout after 15 seconds. If you system will need to do processing that may take longer than 15 seconds, then those process' should be handled on a background thread, background job, or a micro-service.
Events
  1. Resident Admitted *
  2. Resident Discharged *
  3. NRI Submitted *
  4. NRI Approved

Non-implemented events

The starred events are not implemented as of yet. These will be implemented in the near future.

For Resident events the following is the webhook payload:

{
  "residentID": 0,
  "companyGuid": "00000000-0000-0000-0000-000000000000",
  "companyID": 0,
  "event": "event name" // ResidentAdmit or ResidentDischarge
}

For NRI events the following is the webhook payload:

{
  "nriID": 0,
  "residentID": 0,
  "companyGuid": "00000000-0000-0000-0000-000000000000",
  "companyID": 0,
  "event": "event name" // NriSubmitted or NriApproved
}