Overview
You can also create, edit or remove webhook subscriptions via our API. Please refer to our webhook API documentation for more information.
To create a webhook subscription you will need to provide a URL where the specified webhook payload will be POSTed.
If you would like to secure the request handling on your side, the webhook configuration can be set so that requests will be sent with a Basic Auth header. To enable this header, please specify a username/password that should be sent in the request when creating the subscription. The username and password will be converted to Base64 string and will be sent in an "authorization" header alongside each request.
Events
Ovation supports sending web-hooks for the following events:
| Name | Description |
| requisition_signed_accession | Triggered when a Req Form is verified |
| report_signed |
Triggered when an initial report (or a regenerated report of type Final) is signed |
| report_corrected |
The same as report_signed except that it is when a regenerated report of type Correction is signed Refer to the article for report_signed. |
| report_ready_for_generation | Triggered when an initial report (or a regenerated report of type Final) is created |
| report_correction_ready_for_generation | The same as report_ready_for_generation except that it is triggered when a regenerated report of type Correction is created Refer to the article for report_ready_for_generation. |
| sample_rejected |
Triggered when a sample is confirmed as rejected |
| requisition_canceled |
Triggered when a requisition is canceled |
Webhook Error Handling
For each webhook request, Ovation expects to receive a 2** status code within ten seconds for it to be considered successful.
If any of the other response codes are returned or if the request times out, then Ovation will retry the request up to two more times:
The schedule for the 2 additional attempts would be as follows: 64s, 729s
If the two additional attempts fail, the system will not try to resend the request again.
Webhook Event Log
There is an event log located in the integrations page. Navigate to More => Lab => Integrations and you will see a "Webhooks" button in the top right corner of page.
That will take you to the event logs page for webhooks. This page will display all webhook events that Ovation attempted to send for the last thirty days, including any that may have failed.
From this page you can see status of events including their payload and responses. You can also resend selected events from this page.
You need the "Webhook Admin" or "Webhook User" permission to access this page. You also need same permission to view events in log. If you have the "Webhook Admin" permission, you will see all webhook events; if you have the "Webhook User" permission, you will only see the events for endpoints that you are assigned to.
