Subscribe to Monitoring Insights

POST /cra/monitoring_insights/subscribe

This endpoint allows you to subscribe to insights for a user's linked CRA items, which are updated between one and four times per day (best-effort).

Request Body

Required

CraMonitoringInsightsSubscribeRequest defines the request schema for /cra/monitoring_insights/subscribe

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.
item_id
string
The item ID to subscribe for Cash Flow Updates.
user_id
object
webhook
required, string
URL to which Plaid will send Cash Flow Updates webhooks, for example when the requested Cash Flow Updates report is ready.
income_categories
array[string]
Income categories to include in Cash Flow Updates. If empty or null, this field will default to including all possible categories.

Response

CraMonitoringInsightsSubscribeResponse defines the response schema for cra/monitoring_insights/subscribe

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.
subscription_id
required, string
A unique identifier for the subscription.