User Forms Webhooks
Sent when user form events occur.
User forms can come from two sources:
- Document uploads.
- Response forms when users cannot find their employer or payroll provider.
#Submitted
The user_forms.submitted webhook is sent when a user submits a user form and a new user form object is created.
- eventsarray of stringsrequired
user_forms.submitted - 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.
- eventstring
user_forms.submitted - namestring
Name used for the webhook subscription.
- dataobject
- accountstring
ID of the account.
- userstring
ID of the user.
- user_formstring
ID of the user form.
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_forms.submitted"],
7 "name": "name-for-the-webhook-subscription",
8 "url": "https://your-webhook-backend.com",
9 "secret": "optional-secret"
10 }'1{
2 "event": "user_forms.submitted",
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_form": "0187bf23-cd80-118d-c0b8-58023e21c8e5"
8 }
9}#Removed
The user_forms.removed webhook is sent when a user returns to Link and deletes their previously uploaded documents, or when an account is deleted entirely.
- eventsarray of stringsrequired
user_forms.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.
- eventstring
user_forms.removed - namestring
Name used for the webhook subscription.
- dataobject
- accountstring
ID of the account.
- userstring
ID of the user.
- user_formstring
ID of the user form.
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_forms.removed"],
7 "name": "name-for-the-webhook-subscription",
8 "url": "https://your-webhook-backend.com",
9 "secret": "optional-secret"
10 }'1{
2 "event": "user_forms.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_form": "0187bf23-cd80-118d-c0b8-58023e21c8e5"
8 }
9}#OCR completed
The user_forms.ocr_completed webhook is sent when third party OCR data is available for an uploaded document.
If multiple documents are submitted at the same time, this webhook is sent if third party OCR has successfully completed for at least one uploaded document. If any third party OCR errors occurred for the remaining uploaded documents, they will be listed in the ocr_data object of the user forms object in an error field.
- eventsarray of stringsrequired
user_forms.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.
- eventstring
user_forms.ocr_completed - namestring
Name used for the webhook subscription.
- dataobject
- accountstring
ID of the account.
- userstring
ID of the user.
- user_formstring
ID of the user form.
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_forms.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_forms.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_form": "0187bf23-cd80-118d-c0b8-58023e21c8e5"
8 }
9}#OCR failed
The user_forms.ocr_failed webhook is sent when third party OCR processing could not be completed for all uploaded documents in a single user form submission.
Third party OCR errors are returned in the ocr_data object of the user forms object in an error field.
- eventsarray of stringsrequired
user_forms.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.
- eventstring
user_forms.ocr_failed - namestring
Name used for the webhook subscription.
- dataobject
- accountstring
ID of the account.
- userstring
ID of the user.
- user_formstring
ID of the user form.
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_forms.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_forms.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_form": "0187bf23-cd80-118d-c0b8-58023e21c8e5"
8 }
9}