Webhooks

After your document has been created, Abound® will use webhooks to inform your backend of any changes, if applicable.

For both a successful and failed 1099 Form filing, it’s important that you be notified upon an update to the status of your document. Abound® uses webhooks to communicate with your servers when a relevant event occurs.

Documents have two events that can be receive via webhook: documents.created and
documents.updated.

When the webhook status is updated, the returned webhook will also include a resourceStatus. Possible values for a Documents resourceStatus is: created, verifying, pending, done, error. These statuses are also available by getting the resource using the GET /users/{userId}/documents/{documentId} endpoint.

Below is an example of the document webhook when the payment's status has been updated to pending:

{
  "resource": "documents",
  "resourceId": "documentId_XXXXXXXXXXXXXXXXXXXXXX",
  "resourceURL": "https://sandbox-api.withabound.com/<<apiVersion>>/users/userId_0aa8b15c0cce59aa766156e6328798c80512131a/documents/documentId_9a1ccd4967787ea24bbcc2e818f619697b518338",
  "resourceStatus": "pending",
  "event": "documents.updated",
  "userId": "userId_0aa8b15c0cce59aa766156e6328798c80512131a",
  "webhookId": "webhookId_XYZZYXYZZYXYZZY",
  "webhookURL": "https://webhook.site/e665ac70-4914-4d8b-ab48-fa2b47680b4a",
  "webhookRequestId": "webhookRequestId_YYYYYYYYYYYY"
}

If an error occurs on the resource connected to the webhook, the webhook will also return a resourceMessage

{
  "resource": "documents",
  "resourceId": "documentId_documentId_XXXXXXXXXXXXXXXXXXXXXX",
  "resourceURL": "https://sandbox-api.withabound.com/<<apiVersion>>/users/userId_0aa8b15c0cce59aa766156e6328798c80512131a/documents/documentId_9a1ccd4967787ea24bbcc2e818f619697b518338",
  "resourceStatus": "error",
  "resourceMessage": "payerError",
  "event": "documents.updated",
  "userId": "userId_0aa8b15c0cce59aa766156e6328798c80512131a",
  "webhookId": "webhookId_XYZZYXYZZYXYZZY",
  "webhookURL": "https://webhook.site/e665ac70-4914-4d8b-ab48-fa2b47680b4a",
  "webhookRequestId": "webhookRequestId_YYYYYYYYYYYY"
}