In some scenarios, it may be necessary to wait for a Book to reach a certain status before you can perform any action.

📘

Note

For instance, every Document in a Book must achieve VERIFICATION_COMPLETE status before you can request analytics for the Book. To check if verification status is complete, poll the Book status endpoint.

Receive notification about document completion

You can receive notifications about document completion using the following methods:

Webhooks

Utilize webhooks to receive real-time notifications about document processing status like document completion. Webhooks send HTTP POST requests to your specified endpoint whenever a relevant event occurs to ensure immediate updates without the need for continuous polling. To know more about configuring and using webhooks, see, webhooks.

Polling

If setting up a publicly exposed endpoint is not feasible, you can use polling to check the status of document completion. Polling involves repeatedly calling a specific status query endpoint to check for updates.

Since the status of endpoints does not frequently change, polling the same endpoint repeatedly is likely to provide the same result most of the time. To improve efficiency, it is recommended to poll at larger intervals, preferably with a back-off strategy for error conditions. For more information on polling strategies, see, Retry strategies.