Plaid Events

On this page

Cloud Elements supports events via polling or webhooks depending on the API provider. For more information about our Events framework, see Events Overview.

Supported Events and Resources

Cloud Elements supports polling events for Plaid. After receiving an event, Cloud Elements standardizes the payload and sends an event to the configured callback URL of your authenticated element instance.

You can set up polling for the events resource. You can also copy the events configuration to poll other resources. See Configure Polling Through API for more information.

Note: Unless configured for a specific time zone, polling occurs in UTC.

Configure Polling Through the UI

To configure polling through the UI, follow the same steps to authenticate an element instance, and then turn on events. Select the resources to poll, and then click Create Instance. For more information, see Authenticate an Element Instance with Events (UI) or the element-specific authentication topic.

Configure Polling Through API

Use the /instances endpoint to authenticate with Plaid and create an element instance with polling enabled.

Note: The endpoint returns an element instance token and id upon successful completion. Retain the token and id for all subsequent requests involving this element instance.

To authenticate an element instance with polling:

  1. Get an authorization grant code by completing the steps in Getting a redirect URL and Authenticating users and receiving the authorization grant code.
  2. Construct a JSON body as shown below (see Parameters):
  "element": {
    "key": "plaid"
  "configuration": {
    "public_key": "<Plaid public_key>",
    "secret": "<Plaid secret>",
    "client_id": "<Plaid client_id>",
    "subdomain": "<Plaid API environment>",
    "password": "User's password",
    "username": "User's user name",
    "bank_name": "Supported Plaid Institution Name",
    "products": "<Comma separated list of products>",
    "event.notification.enabled": true,
    "event.vendor.type": "polling",
    "event.notification.callback.url": "",
    "event.poller.refresh_interval": "<minutes>",
      "transactions": {
        "url": "/hubs/finance/transactions?where=date>'${date:yyyy-MM-dd}'",
        "idField": "transaction_id",
        "xPath": "transaction_id",
        "datesConfiguration": {
          "updatedDateField": "date",
          "updatedDateFormat": "yyyy-MM-dd",
          "createdDateField": "date",
          "createdDateFormat": "yyyy-MM-dd"
  "tags": [
  "name": "<INSTANCE_NAME>"
  1. Call the following, including the JSON body you constructed in the previous step:

    POST /instances
    Note: Make sure that you include the User and Organization keys in the header. For more information, see Authorization Headers, Organization Secret, and User Secret.
  2. Locate the token and id in the response and save them for all future requests using the element instance.

Example cURL with Polling

curl -X POST \ \
-H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
-H 'content-type: application/json' \
-d '{
"element": {
  "key": "plaid"
"configuration": {
    "public_key": "xxxxxxxxxxxxxxxxxx",
    "secret": "xxxxxxxxxxxxxxxxxxxxxxxx",
    "client_id": "xxxxxxxxxxxxxxxxxxxxxxxx",
    "subdomain": "sandbox",
    "username": "user_good",
    "password": "pass_good",
    "bank_name": "Tartan Bank",
    "products": "auth, transactions",
    "event.notification.enabled": true,
    "event.vendor.type": "polling",
      "event.notification.callback.url": "",
    "event.poller.refresh_interval": "15",
      "transactions": {
        "url": "/hubs/finance/transactions?where=date>'${date:yyyy-MM-dd}'",
        "idField": "transaction_id",
        "xPath": "transaction_id",
        "datesConfiguration": {
          "updatedDateField": "date",
          "updatedDateFormat": "yyyy-MM-dd",
          "createdDateField": "date",
          "createdDateFormat": "yyyy-MM-dd"
  "tags": [
  "name": "API Instance with Polling"


API parameters not shown in Cloud Elements are in code formatting.

ParameterDescriptionData Type
keyThe element key.
codeThe authorization grant code returned from the API provider in an OAuth 2.0 authentication workflow. Cloud Elements uses the code to retrieve the OAuth access and refresh tokens from the endpoint.string
The name of the element instance created during authentication.string
Plaid Public Key
The Plaid public_key that you noted in API Provider Setupstring
Plaid Secret
The Plaid secret that you noted in API Provider Setupstring
Plaid Client Id
The Plaid client_id that you noted in API Provider Setupstring
The Plaid API environment (sandbox, production, or development) to integrate with.string
User' Bank Username
The user's bank user name.string
User' Bank Password
The user's bank password.string
User's Bank NameThe name of the user's bank that must match an Institution in Plaidstring
A comma-separated list of Plaid products.string
Events Enabled
Optional. Identifies that events are enabled for the element instance.
Default: false.
Event Notification Callback URL
The URL where you want Cloud Elements to send the events.string
Event poller refresh interval (mins)
A number in minutes to identify how often the poller should check for changes.number
Configure Polling
Optional. Configuration parameters for polling.JSON object
Resource to PollThe polling event configuration of the resource that you will monitor.JSON object
The url to query for updates to the resource.String
ID Field
The field in the resource that is used to uniquely identify it.String
Advanced Filtering
Configuration parameters for dates in pollingJSON Object
Updated Date Field
The field that identifies an updated object.String
Updated Date Format
The date format of the field that identifies an updated object.String
Created Date Field
The field that identifies a created object.String
Created Date Format
The date format of the field that identifies a created object.String
tagsOptional. User-defined tags to further identify the instance.string