Skip to main content
Version: 1.7.3

Downtime Alert Webhook

This webhook provides real-time notifications when the TaxBandits API service is unavailable due to scheduled maintenance or an unexpected interruption.

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 'Downtime Alert'.

DowntimeAlert

  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.

Sample webhook payload​

    {
        "EventType": "USER_NOTIFY",
        "ServiceName": "Forms API",
        "ServiceVersion": "v1.7.3",
        "NotificationStatus": "SITE_DOWN",
        "Timestamp": "2025-10-28T07:45:00Z",
        "Message": "Service outage detected.",
        "Reason": "The Forms API is temporarily unavailable due to scheduled maintenance or an unexpected service interruption.",
        "EstimatedRecoveryTime": "2025-10-28T08:15:00Z"
    }

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.