Subscribe and unsubscribe to proactive notifications for a user's income profile

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.

Request Body

Required

CreditBankIncomeWebhookUpdateRequest defines the request schema for /credit/bank_income/webhook/update.

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.
user_token
required, string
The user token associated with the User data is being requested for.
enable_webhooks
required, boolean
Whether the user should be enabled for proactive webhook notifications when their income changes

Response

CreditBankIncomeWebhookUpdateResponse defines the response schema for /credit/bank_income/webhook/update.

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.