---
title: "Fire a test user webhook"
method: POST
path: "/sandbox/user/fire_webhook"
tags: ["plaid"]
---

# Fire a test user webhook

`POST /sandbox/user/fire_webhook`

`/sandbox/user/fire_webhook` functions the same as `/sandbox/item/fire_webhook`, but fires webhooks associated with a user rather than an Item. This endpoint can trigger the following webhooks:

`USER_CHECK_REPORT_READY`: Fired when a Check Report is ready to be retrieved.

`USER_CHECK_REPORT_FAILED`: Fired when a Check Report has failed to generate.

`CHECK_REPORT_READY` / `CHECK_REPORT_FAILED`: The equivalents of the above for integrations that predate the [New User APIs](https://plaid.com/docs/api/users/user-apis).

Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production.

## Request body

- SandboxUserFireWebhookRequest — SandboxUserFireWebhookRequest defines the request schema for `/sandbox/user/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.
  - `user_id` string — A unique user identifier, created by `/user/create`. Integrations that began using `/user/create` after December 10, 2025 use this field to identify a user instead of the `user_token`. For more details, see [New User APIs](https://plaid.com/docs/api/users/user-apis).
  - `user_token` string — The user token associated with the user for which data is being requested. This field is used only by customers with pre-existing integrations that already use the `user_token` field. All other customers should use the `user_id` instead. For more details, see [New User APIs](https://plaid.com/docs/api/users/user-apis).
  - `webhook_type` 'CHECK_REPORT', required — The webhook types that can be fired by this test endpoint.
  - `webhook_code` 'USER_CHECK_REPORT_READY' | 'USER_CHECK_REPORT_FAILED' | 'CHECK_REPORT_READY' | 'CHECK_REPORT_FAILED', required — The webhook codes that can be fired by this test endpoint.
  - `webhook` string, url, required — The destination URL that the test webhook will be sent to.

## Response `200`

success

- SandboxUserFireWebhookResponse — SandboxUserFireWebhookResponse defines the response schema for `/sandbox/user/fire_webhook`
  - `webhook_fired` boolean, required — Value is `true` if the test `webhook_code` was successfully fired.
  - `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/e536704a333f/schema)