Webhooks

Register a Webhook Endpoint

Some operations on Books or Documents take time to complete. For instance, every Document in a Book must be fully processed before analytics are available for it.

We support two options for awaiting the result of a long-running operation:

  1. Regularly poll the Book status endpoint until it delivers the desired response.
  2. Establish a webhook that Ocrolus will call upon an operation's completion.

Polling is simpler to implement and maintain, while webhooks are more reliable and precise.

We currently support one configured webhook per API account, which can be configured with the Configure Webhook endpoint.

Creating a webhook requires two parameters:

  1. URL of your endpoint: This parameter is the address of your webhook endpoint. It will likely exist within your own infrastructure, and must therefore be accessible to Ocrolus. We don't recommend exposing your webhook to the public internet. For more information, see here.
  2. Subscribed events: This parameter lists the significant lifecycle events that will trigger notifications for your endpoint.

Available Events

BOOK_VERIFIED
All Documents within a Book have completed verification or were rejected. Corresponds with the BOOK_COMPLETE status code returned by the Book Status API.
DOC_VERIFIED
A single Document within a Book has completed verification or was rejected. Corresponds with the VERIFICATION_COMPLETE and REJECTED document statuses.
IMAGE_GROUP_VERIFIED
An image group has completed verification.
ANALYTICS_COMPLETED
An asynchronous analytics request has been fulfilled, and the results are now available.
MIDDESK_VERIFIED
Results are available for POST Business API call (Middesk integration).
SUSPICIOUS_ACTIVITY
Instances of suspicious activity have been found in the book. This event relates to our FTD 1.0 functionality; our forthcoming Detect APIs uses document.detect.signal_found instead.
document.detect.signal_found
A submitted document contains signals of suspicious activity.
document.detect.signal_not_found
A submitted document does not contain signals of suspicious activity.

Did this page help you?