---
title: "(Deprecated) Manually fire a Bank Income webhook in Sandbox"
method: POST
path: "/sandbox/bank_income/fire_webhook"
tags: ["plaid"]
deprecated: true
---

# (Deprecated) Manually fire a Bank Income webhook in Sandbox

`POST /sandbox/bank_income/fire_webhook`

## Request

- Base URL: `https://production.plaid.com`
- URL: `https://production.plaid.com/sandbox/bank_income/fire_webhook`
- Auth: API key in header `PLAID-CLIENT-ID` and API key in header `PLAID-SECRET` and API key in header `Plaid-Version`

> **Deprecated.**

Use the `/sandbox/bank_income/fire_webhook` endpoint to manually trigger a Bank Income webhook in the Sandbox environment.

## Request body

- SandboxBankIncomeFireWebhookRequest: SandboxBankIncomeFireWebhookRequest defines the request schema for `/sandbox/bank_income/fire_webhook`
  - `client_id` string: Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
  - `secret` string: Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
  - `webhook_override` string, url: The URL to which the webhook should be sent. If provided, this will override the URL set in the dashboard.
  - `webhook_code` 'BANK_INCOME_REFRESH_UPDATE' | 'BANK_INCOME_REFRESH_COMPLETE', required: The webhook codes this endpoint can be used to test
  - `webhook_fields` SandboxBankIncomeWebhookFireRequestWebhookFields, required: Optional fields which will be populated in the simulated webhook
    - `user_id` string, required: The user id to be returned in INCOME webhooks
    - `bank_income_refresh_complete_result` 'SUCCESS' | 'FAILURE': The result of the bank income refresh report generation `SUCCESS`: The refreshed report was successfully generated and can be retrieved via `/credit/bank_income/get`. `FAILURE`: The refreshed report failed to be generated

## Response `200`

OK

- SandboxBankIncomeFireWebhookResponse: SandboxBankIncomeFireWebhookResponse defines the response schema for `/sandbox/bank_income/fire_webhook`
  - `request_id` string, required: A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

## Other responses

- `default`: Error response

## Changes

- **2026-10-15** `ea443cd78f6f`: 2 warning
  - added the new `CRA_PARTNER_INSIGHTS_ERROR` enum value to the `error_type` response property for the response status `default`
  - added the new `CRA_REPORT_ERROR` enum value to the `error_type` response property for the response status `default`
- **2026-07-22** `a1bbca018160`: 13 warning, 1 info
  - added the new `ASSETS_ERROR` enum value to the `error_type` response property for the response status `default`
  - added the new `CRA_MONITORING_ERROR` enum value to the `error_type` response property for the response status `default`
  - added the new `CREDIT_PROFILE_REPORT_ERROR` enum value to the `error_type` response property for the response status `default`
  - added the new `ENCOMPASS_ERROR` enum value to the `error_type` response property for the response status `default`
  - …10 more
- **2026-06-25** `80d23bfdc2e5`: 1 warning
  - added the new `IDEMPOTENCY_ERROR` enum value to the `error_type` response property for the response status `default`
- **2026-06-10** `fb8c3f188d8b`: 1 warning
  - added the new `BASE_REPORT_ERROR` enum value to the `error_type` response property for the response status `default`
- **2025-12-11** `465584b48c99`: 2 info
  - added the optional property `provided_account_subtypes` to the response with the `default` status
  - added the optional property `required_account_subtypes` to the response with the `default` status

[Operation history](https://skmtc.dev/plaid/apis/the-plaid-api/changes/sandbox/bank_income/fire_webhook/post.md)

---

[API](https://skmtc.dev/plaid/apis/the-plaid-api.md) - [All operations](https://skmtc.dev/plaid/apis/the-plaid-api/llms.txt) - [OpenAPI document](https://skmtc.dev/plaid/apis/the-plaid-api/revisions/ea443cd78f6f?raw)