Contents
| Table of Contents | ||
|---|---|---|
|
...
- Initialize the session
- Receive webhook notifications
- Fetch Retrieve result content
The following sequence diagram shows an example of this flow. Note that the usage of webhooks is not mandatory, and a different approach using a polling method is also possible.
...
A range of different webhooks is available to be sent with notifications about events. Which webhooks you want to receive is a choice in the session request.
| Webhook status | Meaning |
|---|---|
| JsonDataReady | The JSON content is ready for download |
| ReportReady | A PDF report is ready for download |
| AllDone | The session is finished, and all contents are ready for download |
| Failed | Something went wrong, and the session has been canceled. |
...
See the section about webhooks in the API documentation for information about how to consume these notifications.
Part 3:
...
Retrieve result content
The result is a set of different entities:
...