POST /sandbox/bank_income/fire_webhook

Use the /sandbox/bank_income/fire_webhook endpoint to manually trigger a Bank 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
`webhook_code`	String	Yes	The webhook codes this endpoint can be used to test Possible values: `"BANK_INCOME_REFRESH_UPDATE"` `"BANK_INCOME_REFRESH_COMPLETE"`
`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_override`	String	No	The URL to which the webhook should be sent. If provided, this will override the URL set in the dashboard.
`webhook_fields`	Object	Yes	Optional fields which will be populated in the simulated webhook
`webhook_fields.bank_income_refresh_complete_result`	String	No	The result of the bank income refresh report generation `SUCCESS`: The refreshed report was successfully generated and can be retrieved via `/credit/bank_income/get`. `FAILURE`: The refreshed report failed to be generated Possible values: `"FAILURE"` `"SUCCESS"`
`webhook_fields.user_id`	String	Yes	The user id to be returned in INCOME webhooks
`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.

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.