User Uploads Webhooks
Sent when document upload events occur.
#Added
The user_uploads.added webhook is sent:
- When an initial set of uploaded documents are submitted for the first time.
- Each time an additional document is uploaded beyond the initial set of uploaded documents.
- #eventsarray of stringsrequired
user_uploads.added - #namestringrequired
Your name for the webhook subscription.
- #urlstringrequired
Where you want to receive webhook delivery. This can be either a backend URL that you manage, or a URL provided by a webhook management service.
- #secretstringoptional
Optional secret used to verify webhooks.
1curl --request POST \
2 --url https://api.argyle.com/v2/webhooks \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json' \
5 --data '{
6 "events": ["user_uploads.added"],
7 "name": "name-for-the-webhook-subscription",
8 "url": "https://your-webhook-backend.com",
9 "secret": "optional-secret"
10 }'1{
2 "event": "user_uploads.added",
3 "name": "name-for-the-webhook-subscription",
4 "data": {
5 "account": "01856c65-43b6-8b5d-b32a-56b8fbda5c28",
6 "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
7 "user_upload": "01320596-2c3d-189c-53e7-a8ce6d625b33"
8 }
9}#Removed
The user_uploads.removed webhook is sent when a user returns to Link and deletes a previously uploaded document, or an account associated with an uploaded document is deleted entirely.
- #eventsarray of stringsrequired
user_uploads.removed - #namestringrequired
Your name for the webhook subscription.
- #urlstringrequired
Where you want to receive webhook delivery. This can be either a backend URL that you manage, or a URL provided by a webhook management service.
- #secretstringoptional
Optional secret used to verify webhooks.
1curl --request POST \
2 --url https://api.argyle.com/v2/webhooks \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json' \
5 --data '{
6 "events": ["user_uploads.removed"],
7 "name": "name-for-the-webhook-subscription",
8 "url": "https://your-webhook-backend.com",
9 "secret": "optional-secret"
10 }'1{
2 "event": "user_uploads.removed",
3 "name": "name-for-the-webhook-subscription",
4 "data": {
5 "account": "01856c65-43b6-8b5d-b32a-56b8fbda5c28",
6 "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
7 "user_upload": "01320596-2c3d-189c-53e7-a8ce6d625b33"
8 }
9}#OCR completed
The user_uploads.ocr_completed webhook is sent when Ocrolus OCR data is available for an uploaded document.
If multiple documents are submitted at the same time, this webhook is sent if OCR has successfully completed for at least one uploaded document. If any OCR errors occurred for the remaining uploaded documents, they will be listed in the ocr_data object of the user uploads object in an error field.
- #eventsarray of stringsrequired
user_uploads.ocr_completed - #namestringrequired
Your name for the webhook subscription.
- #urlstringrequired
Where you want to receive webhook delivery. This can be either a backend URL that you manage, or a URL provided by a webhook management service.
- #secretstringoptional
Optional secret used to verify webhooks.
1curl --request POST \
2 --url https://api.argyle.com/v2/webhooks \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json' \
5 --data '{
6 "events": ["user_uploads.ocr_completed"],
7 "name": "name-for-the-webhook-subscription",
8 "url": "https://your-webhook-backend.com",
9 "secret": "optional-secret"
10 }'1{
2 "event": "user_uploads.ocr_completed",
3 "name": "name-for-the-webhook-subscription",
4 "data": {
5 "account": "01856c65-43b6-8b5d-b32a-56b8fbda5c28",
6 "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
7 "user_upload": "01320596-2c3d-189c-53e7-a8ce6d625b33"
8 }
9}#OCR failed
The user_uploads.ocr_failed webhook is sent when Ocrolus OCR processing could not be completed for an uploaded document.
OCR errors are returned in the ocr_data object of the user uploads object in an error field.
- #eventsarray of stringsrequired
user_uploads.ocr_failed - #namestringrequired
Your name for the webhook subscription.
- #urlstringrequired
Where you want to receive webhook delivery. This can be either a backend URL that you manage, or a URL provided by a webhook management service.
- #secretstringoptional
Optional secret used to verify webhooks.
1curl --request POST \
2 --url https://api.argyle.com/v2/webhooks \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json' \
5 --data '{
6 "events": ["user_uploads.ocr_failed"],
7 "name": "name-for-the-webhook-subscription",
8 "url": "https://your-webhook-backend.com",
9 "secret": "optional-secret"
10 }'1{
2 "event": "user_uploads.ocr_failed",
3 "name": "name-for-the-webhook-subscription",
4 "data": {
5 "account": "01856c65-43b6-8b5d-b32a-56b8fbda5c28",
6 "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
7 "user_upload": "01609292-1a6e-104d-31b5-e6de2d775a05"
8 }
9}#OCR authenticity
The user_uploads.ocr_authenticity webhook is sent when Ocrolus authenticity data is available for an uploaded document.
- #eventsarray of stringsrequired
user_uploads.ocr_authenticity - #namestringrequired
Your name for the webhook subscription.
- #urlstringrequired
Where you want to receive webhook delivery. This can be either a backend URL that you manage, or a URL provided by a webhook management service.
- #secretstringoptional
Optional secret used to verify webhooks.
1curl --request POST \
2 --url https://api.argyle.com/v2/webhooks \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json' \
5 --data '{
6 "events": ["user_uploads.ocr_authenticity"],
7 "name": "name-for-the-webhook-subscription",
8 "url": "https://your-webhook-backend.com",
9 "secret": "optional-secret"
10 }'1{
2 "event": "user_uploads.ocr_authenticity",
3 "name": "name-for-the-webhook-subscription",
4 "data": {
5 "account": "01856c65-43b6-8b5d-b32a-56b8fbda5c28",
6 "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
7 "user_upload": "01320596-2c3d-189c-53e7-a8ce6d625b33"
8 }
9}