Submitted

Implement the forms.submitted webhook to know when a form object is submitted.

This webhook is triggered when a user submits a form — for example, when a user uploads employment documents and submits the form, or answers and submits an income source form.

Event

forms.submitted

Payload


account string uuid

ID of the account the form was submitted from.


user string uuid

ID of the user associated with the account.


form string uuid

ID of the submitted form.


Examples

curl -X POST https://api-sandbox.develop.argyle.com/v1/webhooks \
  -u api_key_id:api_key_secret \
  -H "Content-Type: application/json" \
  -d '{"events": ["forms.submitted"],
       "secret": "<secret for signature verification>",
       "name": "Form object was submitted.",
       "url": "https://mybackend.com/callback/argyle"}'
{
  "event": "forms.submitted",
  "name": "Form object was submitted.",
  "data": {
    "account": "ada143be-3c90-4534-b7ea-9899674dc6e0",
    "user": "3823026e-a964-45f6-b201-6b8c096b30d3",
    "form": "ada143be-3c90-4534-b7ea-9899674dc6e0"
  }
}