Manually fire an Income webhook
Use the /sandbox/income/fire_webhook endpoint to manually trigger a Payroll or Document Income webhook in the Sandbox environment.
Request body
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.
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.
The Item ID associated with the verification.
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.
The URL to which the webhook should be sent.
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.
The webhook codes that can be fired by this test endpoint.
Response
OK
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.