Manually fire a bank income webhook in sandbox

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.

Request Body

Required

SandboxBankIncomeFireWebhookRequest defines the request schema for /sandbox/bank_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.
webhook_override
string
The URL to which the webhook should be sent. If provided, this will override the URL set in the dashboard.
webhook_code
required, string
The webhook codes this endpoint can be used to test
webhook_fields
required, object
Optional fields which will be populated in the simulated webhook
user_id
required, string
The user id to be returned in INCOME webhooks
bank_income_refresh_complete_result
string
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

Response

SandboxBankIncomeFireWebhookResponse defines the response schema for /sandbox/bank_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.