Skip to main content
Version: 1.7.3

PDF Complete Webhook

TaxBandits API allows you to request PDFs of the 1099/W-2 Form using the GetPDF method. To do so, you must configure Webhook for PDF retrieval.

Steps to Configure Webhook for PDF Complete​

  1. Log in to the Developer Console Site. Navigate to Settings >> Webhook Notifications.

  2. Click the Add Webhook button and choose the Event Type as ‘PDF Complete’.

PDFComplete

  1. 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.

  2. Then, provide a Notify email. This email will be used by TaxBandits to notify you regarding any failed attempts of Webhook posting.

Receive Webhook Requests from API​

Once the Webhooks are configured, our API will issue an HTTP Post to the Webhook URL when a PDF is requested using the GetPDF method. The request’s POST parameter will contain the link to download the zip file containing completed Form PDFs.

Here is the sample Webhook POST for the GetPDF request of Form 1099-NEC:

    {
        "SubmissionId": "b870040d-fded-420b-b424-28bf0dd11261",
        "FormType": "FORM1099NEC",
        "Records": [
            {
                 "RecordId": "5e2433ef-0d2e-4d8d-beba-06dac739a9fc",
                 "SequenceId": "001",
                 "FileName": "5e2433ef-0d2e-4d8d-beba-06dac739a9fc.Zip",
                 "FilePath": "https://filepath/5e2433ef-0d2e-4d8d-beba-06dac739a9fc.zip",
                 "Status": "SUCCESS",
                 "StatusTime": "2023-12-06T07:31:34.3884233-05:00",
                 "Errors": null
            }
        ]
    }

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.