Online Access Status Change
If you've chosen Online Access services to distribute recipient copies of 1099, W-2, ACA, or other forms, configure this Webhook to receive notifications about the distribution.
Steps to Configure Webhook for Online Access Status Change
-
Log in to the Developer Console Site. Navigate to Settings >> Webhook Notifications.
-
Click the Add Webhook button and choose the Event Type as ‘Online Access Status Change’.
-
Enter the callback URL and click on the Submit button. Ensure that the callback URL you enter is valid, as the API will authenticate this URL by posting a sample JSON. The URL will be activated only when we receive the 200 response. You must follow these best practices to have a valid callback URL for Webhook.
-
Then, provide a Notify email. This email will be used by TaxBandits to notify you regarding any failed attempts of Webhook posting.
Status
Following are the different types of status that you will receive through Webhooks.
ConsentStatus:
- CONSENTED - The recipient has given consent for the portal.
- CONSENTED_WITHDRAWN - The recipient has withdrawn consent for online access.
OnlineAccessStatus:
- EMAIL_SENT - An invitation email for online access has been sent to the recipient.
- PDF_VIEWED - The recipient has viewed the PDF (e.g., 1099 NEC return).
- PDF_DOWNLOADED - The recipient has downloaded the PDF.
Receive Webhook Requests from API
Once the Webhooks are configured, and the callback URL is authenticated by receiving a 200 response using a sample post, our API will start issuing an HTTP Post to the URL every time your recipient copies are shared. The request’s POST parameter will contain JSON data.
Here is the sample Webhook Post:
{
"SubmissionId": "b870040d-fded-420b-b424-28bf0dd11261",
"RecordId": "5e2433ef-0d2e-4d8d-beba-06dac739a9fc",
"RecipientId": "f871240d-fded-420b-b424-28bf0dd11261",
"PayeeRef": "Pe12345",
"Email": "james@sample.com",
"AccountNum": "2024123451234",
"FormType": "FORM1099NEC",
"ConsentStatus": "CONSENTED",
"ConsentStatusTs": "2024-12-24 00:19:48 -05:00",
"OnlineAccessStatus": "EMAIL_SENT",
"OnlineAccessStatusTs": "2024-12-24 00:19:48 -05:00"
}
Respond to Webhook Post from API
You must respond to the Webhook post by sending an HTTP 200 OK Response. Any other code other than 200 will be treated as an incomplete call. This API does not support 301 redirects, which will be treated as an error. Learn more
You are required to initiate a response to our Webhook request within 5 seconds, if not, the request will be treated as timeout. If the API doesn’t receive a response during the 5-second time window or in case of an error, it will attempt to retry the connection a total of 9 times within 24 hours.
Before you respond to a Webhook request, you must validate if the request was sent from TaxBandits. To learn how to validate Webhook requests, click here.