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).

Servers

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.

income_categories[] Array No

Income categories to include in Cash Flow Updates. If empty or null, this field will default to including all possible categories.

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 String Yes

URL to which Plaid will send Cash Flow Updates webhooks, for example when the requested Cash Flow Updates report is ready.

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.

item_id String No

The item ID to subscribe for Cash Flow Updates.

user_id String No

A unique ID generated by Plaid representing the end user. Typically, this ID will come from the /user/create response, when the endpoint is invoked with the PLAID-NEW-USER-API-ENABLED header. If this field is included, then the user_token object field is ignored.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.