Sign in
plaid

Fire a test 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).

post/sandbox/item/fire_webhook

Request body

client_idstring

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.

secretstring

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

success

webhook_firedboolean required

Value is true if the test webhook_code was successfully fired.

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Changes