POST /credit/bank_income/webhook/update
/credit/bank_income/webhook/update allows you to subscribe or unsubscribe a user for income webhook notifications. By default, all users start out unsubscribed.
If a user is subscribed, on significant changes to the user's income profile, you will receive a BANK_INCOME_REFRESH_UPDATE webhook, prompting you to refresh bank income data for the user.
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 |
|---|---|---|---|
user_token |
String | Yes |
The user token associated with the User data is being requested for. |
client_id |
String | No |
Your Plaid API |
enable_webhooks |
Boolean | Yes |
Whether the user should be enabled for proactive webhook notifications when their income changes |
secret |
String | No |
Your Plaid API |
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.