Plaid

Overview

Authenticate

Events

Bulk

Querying

API Docs

Events

Cloud Elements supports events via polling or webhooks depending on the API provider. If you would like to see more information on our Events framework, please see the Event Management Guide.

On this page
Supported Events and Resources
Polling
Parameters

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 transactions resource. You can also copy the transactions configuration to poll other resources. See Configure Polling Through API for more information.

Note: You can set up polling for other resources that include created, updated, and deleted data through our API. Copy the configuration of one of the default resources, and replace the name with the resource that you want to poll.

Polling

You can configure polling through the UI or in the JSON body of the /instances API request .

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

Configure Polling Through the UI

For more information about each field described here, see Parameters.

To authenticate an element instance with polling:

Enter the basic information required to authenticate an element instance as described in Authenticate with Plaid .
To enable hash verification in the headers of event callbacks, click Show Optional Fields, and then add a key to Callback Notification Signature Key.
Enable events: Switch Events Enabled on.
Add an Event Notification Callback URL.
Use the Event poller refresh interval (mins) slider or enter a number in minutes to specify how often Cloud Elements should poll for changes.
Select the resources to poll.
Advanced users can further configure polling:
- Click to edit the polling configuration JSON directly.
- Click to access the poller configuration.
Optionally type or select one or more Element Instance Tags to add to the authenticated element instance.
Click Create Instance.

After successfully authenticating, we give you several options for next steps. Make requests using the API docs associated with the instance, map the instance to a virtual data resource, or use it in a formula template.

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:

Get an authorization grant code by completing the steps in Getting a redirect URL and Authenticating users and receiving the authorization grant code.
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": "http://mycoolapp.com",
    "event.poller.refresh_interval": "<minutes>",
    "event.poller.configuration":{
      "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": [
    "<Add_Your_Tag>"
  ],
  "name": "<INSTANCE_NAME>"
}

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. See the Overview for details.
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 \
https://api.cloud-elements.com/elements/api-v2/instances \
-H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
-H 'content-type: application/json' \
-d '{
"element": {
  "key": "plaid"
},
"providerData":{
  "code": "<AUTHORIZATION_GRANT_CODE>"
},
"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": "https://api.cloud-elements.com/elements/api-v2/events/plaid/",
    "event.poller.refresh_interval": "15",
    "event.poller.configuration":{
      "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": [
    "Docs"
  ],
  "name": "API Instance with Polling"
}'

Parameters

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

Parameter	Description	Data Type
`key`	The element key. plaid	string
`code`	The 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
Name `name`	The name of the element instance created during authentication.	string
Plaid Public Key `public_key`	The Plaid public_key that you noted in API Provider Setup.	string
Plaid Secret `secret`	The Plaid secret that you noted in API Provider Setup.	string
Plaid Client Id `client_id`	The Plaid client_id that you noted in API Provider Setup.	string
subdomain `subdomain`	The Plaid API environment (sandbox, production, or development) to integrate with.	string
User' Bank Username `username`	The user's bank user name.	string
User' Bank Password `password`	The user's bank password.	string
User's Bank Name	The name of the user's bank that must match an Institution in Plaid	string
Products `products`	A comma-separated list of Plaid products.	string
Events Enabled `event.notification.enabled`	Optional. Identifies that events are enabled for the element instance. Default: `false`.	boolean
Event Notification Callback URL `event.notification.callback.url`	The URL where you want Cloud Elements to send the events.	string
Event poller refresh interval (mins) `event.poller.refresh_interval`	A number in minutes to identify how often the poller should check for changes.	number
Configure Polling `event.poller.configuration`	Optional. Configuration parameters for polling.	JSON object
Resource to Poll	The polling event configuration of the resource that you will monitor.	JSON object
URL `url`	The url to query for updates to the resource.	String
ID Field `idField`	The field in the resource that is used to uniquely identify it.	String
Advanced Filtering `datesConfiguration`	Configuration parameters for dates in polling	JSON Object
Updated Date Field `updatedDateField`	The field that identifies an updated object.	String
Updated Date Format `updatedDateFormat`	The date format of the field that identifies an updated object.	String
Created Date Field `createdDateField`	The field that identifies a created object.	String
Created Date Format `createdDateFormat`	The date format of the field that identifies a created object.	String
tags	Optional. User-defined tags to further identify the instance.	string