Skip to main content
Version: 2.0.0

State Payroll Filings Status Change Webhook

This webhook can be configured to receive real-time notifications regarding the status of state payroll forms (withholding or Unemployment Insurance forms) filed through TaxBandits API.

Steps to configure webhook​​

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

  2. Add a webhook
    Click ‘Add Webhook’ and select the event type ‘State Payroll Filings Status Change’.

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.
  1. Configure a notification email
    Provide a notification email address. TaxBandits will use this email to alert you if webhook delivery attempts fail.

Statuses available​

The following are the different statuses available.

  • SENT_TO_AGENCY - The state form has been sent to the state agency and is awaiting the result.
  • ACCEPTED - The state form is accepted by the state agency.
  • REJECTED - The state form is rejected by the state agency.

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": "01995bd0-1d22-72a8-87d8-632d4249d46f",
    "PayerRef": null,
    "Records": [
      {
        "BusinessId": "44daf14a-521f-4e62-97fc-6736189310dd",
        "PayerRef": "7346",
        "FormType": "WH1605",
        "RecordId": "01995bd0-1df0-76bc-a728-8ad2dfdde263",
        "State": "SC",
        "Status": "ACCEPTED",
        "StatusCode": "SF004",
        "StatusTs": "2025-09-17T23:55:11.7530000-04:00",
        "Info": null,
        "FilingReference": {
          "FiledWith": null,
          "FilingRef": "WH-SC-25-261-0009"
        },
        "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.