User Uploads Webhooks

Sent when document upload events occur.

#Added

post/v2/webhooks

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.
Request body
  • #
    eventsarray of strings
    required

    user_uploads.added

  • #
    namestring
    required

    Your name for the webhook subscription.

  • #
    urlstring
    required

    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.

  • #
    secretstring
    optional

    Optional secret used to verify webhooks.

Webhook message
  • #
    eventstring

    user_uploads.added

  • #
    namestring

    Name used for the webhook subscription.

  • #
    dataobject

  • #
    accountstring (uuid)

    ID of the account.

  • #
    userstring (uuid)

    ID of the user.

  • #
    user_uploadstring (uuid)

    ID of the uploaded document.

Example Subscription
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     }'
Example Webhook
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

post/v2/webhooks

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.

Request body
  • #
    eventsarray of strings
    required

    user_uploads.removed

  • #
    namestring
    required

    Your name for the webhook subscription.

  • #
    urlstring
    required

    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.

  • #
    secretstring
    optional

    Optional secret used to verify webhooks.

Webhook message
  • #
    eventstring

    user_uploads.removed

  • #
    namestring

    Name used for the webhook subscription.

  • #
    dataobject

  • #
    accountstring (uuid)

    ID of the account.

  • #
    userstring (uuid)

    ID of the user.

  • #
    user_uploadstring (uuid)

    ID of the uploaded document.

Example Subscription
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     }'
Example Webhook
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

post/v2/webhooks

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.

Request body
  • #
    eventsarray of strings
    required

    user_uploads.ocr_completed

  • #
    namestring
    required

    Your name for the webhook subscription.

  • #
    urlstring
    required

    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.

  • #
    secretstring
    optional

    Optional secret used to verify webhooks.

Webhook message
  • #
    eventstring

    user_uploads.ocr_completed

  • #
    namestring

    Name used for the webhook subscription.

  • #
    dataobject

  • #
    accountstring (uuid)

    ID of the account.

  • #
    userstring (uuid)

    ID of the user.

  • #
    user_uploadstring (uuid)

    ID of the uploaded document.

Example Subscription
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     }'
Example Webhook
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

post/v2/webhooks

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.

Request body
  • #
    eventsarray of strings
    required

    user_uploads.ocr_failed

  • #
    namestring
    required

    Your name for the webhook subscription.

  • #
    urlstring
    required

    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.

  • #
    secretstring
    optional

    Optional secret used to verify webhooks.

Webhook message
  • #
    eventstring

    user_uploads.ocr_failed

  • #
    namestring

    Name used for the webhook subscription.

  • #
    dataobject

  • #
    accountstring (uuid)

    ID of the account.

  • #
    userstring (uuid)

    ID of the user.

  • #
    user_uploadstring (uuid)

    ID of the uploaded document.

Example Subscription
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     }'
Example Webhook
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

post/v2/webhooks

The user_uploads.ocr_authenticity webhook is sent when Ocrolus authenticity data is available for an uploaded document.

Request body
  • #
    eventsarray of strings
    required

    user_uploads.ocr_authenticity

  • #
    namestring
    required

    Your name for the webhook subscription.

  • #
    urlstring
    required

    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.

  • #
    secretstring
    optional

    Optional secret used to verify webhooks.

Webhook message
  • #
    eventstring

    user_uploads.ocr_authenticity

  • #
    namestring

    Name used for the webhook subscription.

  • #
    dataobject

  • #
    accountstring (uuid)

    ID of the account.

  • #
    userstring (uuid)

    ID of the user.

  • #
    user_uploadstring (uuid)

    ID of the uploaded document.

Example Subscription
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     }'
Example Webhook
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}
Updating Argyle status...
┬ę 2024 Argyle Systems Inc.argyle.com