Digitoo.ai
Migrations

Migrate external validation webhooks

Webhooks used for external validation during document annotation are newly moved to the queue itself since it is only possible to define a single webhook for each queue

The now legacy webhooks endpoints for creating these are still available however they are now deprecated and will be removed in future versions of the API. This change is only valid for webhooks of type:

  • document_validation
  • initial_document_validation

All historical validation webhooks have already been migrated to its queues, so there is no further action required from your side.

In order to manage the external validations, new endpoints have been created:

TerminalCode
curl -L \ --request POST \ --url '/api/v2/queues/123e4567-e89b-12d3-a456-426614174000/external-validation-links' \ --header 'Authorization: Bearer JWT' \ --header 'Content-Type: application/json' \ --data '{ "url": "text", "type": "initial_document_validation", "signature_verification": "enabled" }'

This endpoint is used for both create and update.

If you want to delete this webhook, following endpoint is available:

TerminalCode
curl -L \ --request DELETE \ --url '/api/v2/queues/123e4567-e89b-12d3-a456-426614174000/external-validation-links/initial_document_validation' \ --header 'Authorization: Bearer JWT' \ --header 'Content-Type: application/json' \

In order to see whether there are some external validation links available, following endpoint is operational:

TerminalCode
curl -L \ --request GET \ --url '/api/v2/queues/123e4567-e89b-12d3-a456-426614174000/external-validation-links' \ --header 'Authorization: Bearer JWT' \ --header 'Content-Type: application/json' \
Last modified on