Versions Compared

Version Old Version 1 New Version 2
Changes made by

Kristoffer Kristoffer (Unlicensed)

Kristoffer Kristoffer (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space PDOIDC and version master

Contents

Table of Contents
excludeContents

...

Note

The Asynchronous Session API is currently in a

Status
colourYellow
titleBeta
stage.

There might still be some bugs or inconsistencies, and changes could happen.

Please contact the team if you want to test out this API at this stage.

When this API is finished and ready, the old synchronous API will be

Status
titledeprecated
.

At that point

  • We will encourage all existing integration partners to migrate to the new asynchronous alternative
  • New integration partners must only use the asynchronous API

Summary of message flow

The recommended A typical message flow can be divided into three main parts:

...

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 statusMeaning
JsonDataReadyThe JSON content is ready for download
ReportReadyA PDF report is ready for download
AllDoneThe session is finished, and all contents are ready for download
FailedSomething went wrong, and the session has been canceled.

...