Skip to main content
Version: 2.0.0

Postal Mailing Sent

This webhook provides real-time notifications when recipient copies of 1099, W-2, etc., have been successfully mailed via postal delivery.

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 'Postal Mailing Sent'.

PostalSent

  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": "f8ffd933-3a89-45ee-96d8-814cf039f7b6",
         "RecordId": "22a5f77e-aad9-4765-8ca1-4bfc1c224ec7",
         "RecipientId": "144b9ab4-d5a3-4d9c-bee1-4838e006e23b",
         "PayeeRef": "Payee001",
         "AccountNum": "123456",
         "FormType": "Form1099NEC",
         "PostalStatus": "SENT",
         "StatusTs": "2023-12-11T08:29:01.8989041-05:00"
    }

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.