Skip to main content
Version: 2.0.0

PDF Generation

This webhook event should be configured to receive PDF copies of completed form copies of 1099, W-2, etc. via the GetPDF endpoint.

Steps to Configure​

  1. Log in to Developer Console
    Navigate to 'Settings' → 'Webhook Notifications'.

  2. Add a webhook
    Click 'Add Webhook' and select the event type 'PDF Generation'.

PDFComplete

  1. Provide a callback URL
    Enter a valid HTTPS callback URL (maximum 500 characters). Ensure that your callback URL follows these best practices.

    • The API validates this URL by sending a sample JSON payload.
    • The webhook will be activated only after your endpoint responds with an HTTP 200 status code.

  2. Configure a notification email
    Provide a notification email address. TaxBandits will use this email to alert you if webhook delivery attempts fail.

Receiving webhook requests​

Once the webhook is configured and the callback URL is successfully authenticated, TaxBandits will send an HTTP POST request to your callback URL whenever a filing status changes.

Each request contains a JSON payload with submission details and record-level status information.

Sample webhook payload​

    {
        "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
            }
        ]
    }

Responding to webhook requests​

Your application must respond with HTTP 200 OK to acknowledge receipt of a webhook request.

  • Any response other than 200 is treated as a failed delivery
  • HTTP redirects (301) are not supported and are treated as errors
  • Your endpoint must respond within 5 seconds, or the request is considered a timeout

If a webhook delivery fails or times out, TaxBandits will retry the request up to 9 times within 24 hours.

Validating webhook requests​

Before processing a webhook payload, you must verify that the request originated from TaxBandits.Refer to the Webhook validation documentation to learn how to authenticate incoming webhook requests.