View as Markdown
Plaid icon

Plaid TRIGGER

New Accounts Available (Instant)

Emit new event when there are new accounts available at the Financial Institution. See the documentation.
  • Trigger
  • Instant
  • API key
  • Webhook delivery

IMPLEMENTATION

Deploy this event source

Connect the user's Plaid account, configure the source, and choose the webhook where your backend receives events.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const deployed = await pd.triggers.deploy({
  id: "plaid-new-accounts-available-instant",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    plaid: { authProvisionId: "apn_xxxxxxx" },
    products: ["Products"],
    requiredIfSupportedProducts: ["Required If Supported Products"],
  },
  webhookUrl: "https://example.com/webhooks/plaid",
})

console.log(deployed.id)

MCP exposes on-demand actions. Event sources are deployed through the Connect SDK or API because they continue listening after the initial request.

SCHEMA

Configuration

These inputs define which events the source watches. Dynamic options are loaded from the connected account.

New Accounts Available (Instant) configuration
Property Type Description
products Products string[]
List of Plaid product(s) you wish to use. If launching Link in update mode, should be omitted (unless you are using update mode to add Income or Assets to an Item); required otherwise. See the documentation.
Optional
requiredIfSupportedProducts Required If Supported Products string[]
List of Plaid product(s) you wish to use only if the institution and account(s) selected by the user support the product. Institutions that do not support these products will still be shown in Link. The products will only be extracted and billed if the user selects an institution and account type that supports them. See the documentation.
Optional
optionalProducts Optional Products string[]
List of Plaid product(s) that will enhance the consumer's use case, but that your app can function without. Plaid will attempt to fetch data for these products on a best-effort basis, and failure to support these products will not affect Item creation. See the documentation.
Optional
additionalConsentedProducts Additional Consented Products string[]
List of additional Plaid product(s) you wish to collect consent for to support your use case. These products will not be billed until you start using them by calling the relevant endpoints. See the documentation.
Optional

01

Connect

Your user authorizes Plaid through Pipedream managed auth.

02

Deploy

Your backend deploys this source with that user's own configuration.

03

Webhook delivery

Every event is sent to the HTTP endpoint you choose when you deploy the source — as it happens.

OR

On-demand retrieval

No webhook required. Your app or agent can fetch recent events from the trigger events API.

Registry key
plaid-new-accounts-available-instant
Version
0.0.1
App
Plaid
Authentication
API key
Delivery
Instant event
Output
Events emitted by Plaid.