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

# Fire a test webhook

`POST /sandbox/item/fire_webhook`

The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks:

`DEFAULT_UPDATE`: Transactions update webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result.

`NEW_ACCOUNTS_AVAILABLE`: Webhook to be fired for a given Sandbox Item created with Account Select v2.

`AUTH_DATA_UPDATE`: Webhook to be fired for a given Sandbox Item created with Auth as an enabled product.

`SMS_MICRODEPOSITS_VERIFICATION`: Fired when a given same day micro-deposit item is verified via SMS verification.

`LOGIN_REPAIRED`: Fired when an Item recovers from the `ITEM_LOGIN_REQUIRED` without the user going through update mode in your app.

`RECURRING_TRANSACTIONS_UPDATE`: Recurring Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Recurring Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result.

`SYNC_UPDATES_AVAILABLE`: Transactions webhook to be fired for a given Sandbox Item.  If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result.

`PRODUCT_READY`: Assets webhook to be fired when a given asset report has been successfully generated. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result.

`ERROR`: Assets webhook to be fired when asset report generation has failed. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result.

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 or Development (except for webhooks of type `TRANSFER`).

## Request body

- SandboxItemFireWebhookRequest — SandboxItemFireWebhookRequest defines the request schema for `/sandbox/item/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.
  - `access_token` string, required — The access token associated with the Item data is being requested for.
  - `webhook_type` 'AUTH' | 'HOLDINGS' | 'INVESTMENTS_TRANSACTIONS' | 'ITEM' | 'LIABILITIES' | 'TRANSACTIONS' | 'ASSETS' — The webhook types that can be fired by this test endpoint.
  - `webhook_code` 'DEFAULT_UPDATE' | 'NEW_ACCOUNTS_AVAILABLE' | 'AUTH_DATA_UPDATE' | 'SMS_MICRODEPOSITS_VERIFICATION' | 'AUTHORIZATION_GRANTED' | 'RECURRING_TRANSACTIONS_UPDATE' | 'SYNC_UPDATES_AVAILABLE' | 'PRODUCT_READY' | 'ERROR', required — The webhook codes that can be fired by this test endpoint.

## Response `200`

success

- SandboxItemFireWebhookResponse — SandboxItemFireWebhookResponse defines the response schema for `/sandbox/item/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.

## Changes

- **2024-05-03** `1550c043ed31` — 1 info
  - added the new `SMS_MICRODEPOSITS_VERIFICATION` enum value to the request property `webhook_code`
- **2024-02-21** `5de70cc1e6ca` — 5 breaking, 3 warning, 12 info
  - removed the enum value `LOGIN_REPAIRED` of the request property `webhook_code`
  - removed the enum value `PENDING_DISCONNECT` of the request property `webhook_code`
  - removed the enum value `SMS_MICRODEPOSITS_VERIFICATION` of the request property `webhook_code`
  - removed the enum value `USER_ACCOUNT_REVOKED` of the request property `webhook_code`
  - …16 more

[Change history](https://skmtc.dev/plaid/apis/the-plaid-api/changes/sandbox/item/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/a5b45bccb4e8/schema)