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.

Servers

https://production.plaid.com
https://sandbox.plaid.com

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`verification_status`	String	No	`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. Possible values: `"VERIFICATION_STATUS_PENDING_APPROVAL"` `"VERIFICATION_STATUS_PROCESSING_FAILED"` `"VERIFICATION_STATUS_PROCESSING_COMPLETE"`
`webhook_code`	String	Yes	The webhook codes that can be fired by this test endpoint. Possible values: `"INCOME_VERIFICATION_RISK_SIGNALS"` `"INCOME_VERIFICATION"`
`client_id`	String	No	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.
`webhook`	String	Yes	The URL to which the webhook should be sent.
`secret`	String	No	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`	String	Yes	The Item ID associated with the verification.
`user_id`	String	No	The Plaid `user_id` of the User associated with this webhook, warning, or error.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.