Manually fire an Income webhook

POST /sandbox/income/fire_webhook

Use the /sandbox/income/fire_webhook endpoint to manually trigger a Payroll or Document Income webhook in the Sandbox environment.

Request Body

Required

SandboxIncomeFireWebhookRequest defines the request schema for /sandbox/income/fire_webhook

Parameters

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.
item_id
required, string
The Item ID associated with the verification.
user_id
string
The Plaid user_id of the User associated with this webhook, warning, or error.
webhook
required, string
The URL to which the webhook should be sent.
verification_status
string
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.
webhook_code
required, string
The webhook codes that can be fired by this test endpoint.

Response

SandboxIncomeFireWebhookResponse defines the response schema for /sandbox/income/fire_webhook

Response Properties

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