---
title: "Manually fire an Income webhook"
method: POST
path: "/sandbox/income/fire_webhook"
tags: ["plaid"]
---

# Manually fire an Income webhook

`POST /sandbox/income/fire_webhook`

Use the `/sandbox/income/fire_webhook` endpoint to manually trigger a Payroll or Document Income webhook in the Sandbox environment.

## Request body

- SandboxIncomeFireWebhookRequest — SandboxIncomeFireWebhookRequest defines the request schema for `/sandbox/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.
  - `item_id` string, required — The Item ID associated with the verification.
  - `user_id` string — The user identifier to include in the test webhook. For `USER_INCOME_VERIFICATION` and `USER_INCOME_VERIFICATION_RISK_SIGNALS`, use the `user_id` returned by `/user/create`, which begins with `usr_`. For `INCOME_VERIFICATION` and `INCOME_VERIFICATION_RISK_SIGNALS`, use the legacy webhook `user_id` associated with the user token.
  - `webhook` string, url, required — The URL to which the webhook should be sent.
  - `verification_status` 'VERIFICATION_STATUS_PROCESSING_COMPLETE' | 'VERIFICATION_STATUS_PROCESSING_FAILED' | 'VERIFICATION_STATUS_PENDING_APPROVAL' — `VERIFICATION_STATUS_PROCESSING_COMPLETE`: The income verification status processing has completed. If the user uploaded multiple documents, this webhook will fire when all documents have finished processing. Call the `/income/verification/paystubs/get` endpoint and check the document metadata to see which documents were successfully parsed. `VERIFICATION_STATUS_PROCESSING_FAILED`: A failure occurred when attempting to process the verification documentation. `VERIFICATION_STATUS_PENDING_APPROVAL`: (deprecated) The income verification has been sent to the user for review.
  - `webhook_code` 'INCOME_VERIFICATION' | 'USER_INCOME_VERIFICATION' | 'INCOME_VERIFICATION_RISK_SIGNALS' | 'USER_INCOME_VERIFICATION_RISK_SIGNALS', required — The webhook codes that can be fired by this test endpoint.

## Response `200`

OK

- SandboxIncomeFireWebhookResponse — SandboxIncomeFireWebhookResponse defines the response schema for `/sandbox/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-08-17** `e536704a333f` — 2 info
  - added the new `USER_INCOME_VERIFICATION` enum value to the request property `webhook_code`
  - added the new `USER_INCOME_VERIFICATION_RISK_SIGNALS` enum value to the request property `webhook_code`
- **2026-07-22** `a1bbca018160` — 13 warning
  - 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`
  - …9 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

[Full history](https://skmtc.dev/plaid/apis/the-plaid-api/changes/sandbox/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-service-production.skmtc.workers.dev/v1/apis/plaid/the-plaid-api/revisions/e536704a333f/schema)