---
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`

> **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

---

[API](https://skmtc.net/plaid/apis/the-plaid-api.md) · [All operations](https://skmtc.net/plaid/apis/the-plaid-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/plaid/the-plaid-api/revisions/64c4514ea59b/schema)