Page Comparison

...

• document_text: this event triggers the sending of the document text obtained by OCR

• document_split: this event triggers the sending of section information for a document

• document_predict: this event triggers sending all predictions made on a document

• document_evaluate: this event triggers sending the final, reviewed version of a document once feedback has been received

• document_delete: this event triggers sending a document id when it is deleted

• document_rejectfail: this event triggers to inform sending a document id when a document is rejected. Includes the full payload like document_predict and document_evaluate, examples below.has failed to process

In general, the payload sent by the webhooks has the following form:

...

{"event": "document_delete", "organization": "contractfit1", "data": {"id": "5e7a0df1800de5422a6f7776"}}

document_fail

{"event": "document_fail", "organization": "contractfit1", "data": {"id": "5e7a0df1800de5422a6f7776"}}

...

At minimum, a target url or ip address and an event for which to trigger a webhook need to be configured:

{
  "type": "webhook",
  "events": ["document_predict"],
  "target": "http://localhost:3000/alfred/document_predict"
}

...

Optionally, authorization headers can also be configured throught the “header” field:
A custom (static) authorization (f.e. Bearer token) can be configured in the webhook, which will be sent back as header with the webhook’s POST request. This allows verification and authentication on the client’s side. For example, adding that to the example above:

{
  "type": "webhook",
  "events": ["document_predict"],
  "target": "http://localhost:3000/alfred/document_predict",
  "headers": {"Authorization": "Bearer abcdefg1234567989"}
}

Additionally, we now have Inbox specific webhooks. A recent expansion allows to specifically configure webhooks per Inbox, as well as pass this information along in the payload. The configuration for this will then look as follows:

{
  "type": "webhook",
  "events": ["document_predict"],
  "target": "http://localhost:3000/alfred/document_predict",
  "headers": {"Authorization": "Bearer abcdefg1234567989"}
  "inbox": "abcdef123456789abcdef123"
}

Retry_backoff timings

• 0: immediately

• 1: retry_backoff * 2^0 seconds after attempt 0, so 30 seconds later in the example

• 2: retry_backoff* 2^1 seconds after attempt 1, so 1 minute after attempt 1 and 1'30 after initial attempt

• 3: retry_backoff* 2^2 seconds after attempt 2, so 2 minutes after attempt 2 and 3'30 after initial attempt

• 4: retry_backoff* 2^3 seconds after attempt 3, so 4 minutes after attempt 3 and 7'30 after initial attempt

• 5: retry_backoff* 2^4 seconds after attempt 4, so 8 minutes after attempt 4 and 15'30 after initial attempt