plaid

Fire a test user webhook

Changed on

/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.

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.

post/sandbox/user/fire_webhook

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/sandbox/user/fire_webhook
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

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.

user_idstring

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.

user_tokenstring

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.

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.

webhookstring url required

The destination URL that the test webhook will be sent to.

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

  • ea443cd78f6fRevision changes
    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_REPORT_ERROR enum value to the response property for the response status

  • e536704a333fRevision changes
    • info

      endpoint added