Implement the forms.ocr_completed
webhook to know when third party OCR is completed for uploaded documents.
The forms.ocr_completed
webhook notifies your system when data retrieval through third party OCR is completed for documents manually uploaded by your user through the Document upload flow.
This webhook triggers when OCR is successful for at least one out of all documents within an upload form. If OCR fails for one or more of the remaining documents, the
metadata
field of each failed document returns anocr_data.error
object with the specific type of error. Consult processing errors - third party OCR for more information about possible error types.
Event
forms.ocr_completed
Payload
Attribute | Type | Description |
---|---|---|
account | string uuid | ID of the account for which OCR was completed on a form. |
user | string uuid | ID of the user the account belongs to. |
form | string uuid | ID of the form for which OCR was completed. |
Example
curl -X POST https://api.argyle.com/v1/webhooks \
-u api_key_id:api_key_secret \
-H "Content-Type: application/json" \
-d '{"events": ["forms.ocr_completed"],
"secret": "<secret for signature verification>",
"name": "OCR is completed",
"url": "https://webhook.site/url"}'
{
"event": "forms.ocr_completed",
"name": "OCR is completed",
"data": {
"account": "ada143be-3c90-4534-b7ea-9899674dc6e0",
"user": "3823026e-a964-45f6-b201-6b8c096b30d3",
"form": "ada143be-3c90-4534-b7ea-9899674dc6e0"
}
}
The payload provided by this webhook does not include the actual meta-data contents of the document. You can request these through the
forms
endpoint, by callingGET /forms/:form
with theform
ID received in theforms.ocr_completed
webhook.