plaid

List webhook events

Changed on

/beta/webhook_events/list returns the webhooks Plaid sent to your account in the last 7 days, including webhooks that weren't delivered. Use it to recover webhooks your endpoint missed. Events are returned oldest first.

TRANSACTIONS webhooks are not included. To recover Transactions updates, use /transactions/sync.

To page through events, omit cursor on your first request, then pass the previous response's next_cursor on each later request. Store next_cursor even when has_more is false, so your next poll returns only newer events.

Filters are optional. An event matches a filter if it matches any of the filter's values, and must match every filter you provide.

Events older than 7 days are not retained. If your cursor or start_time is older than that, the request fails with WEBHOOK_EVENTS_CURSOR_EXPIRED or WEBHOOK_EVENTS_START_TIME_OUT_OF_RANGE.

This endpoint is in beta and may change in backwards-incompatible ways. Send feedback to building@plaid.com.

post/beta/webhook_events/list

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/beta/webhook_events/list
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

Request body

client_idstring

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.

secretstring

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.

cursorstring

The next_cursor from a previous /beta/webhook_events/list response. Omit on your first request. If provided, start_time is ignored.

start_timestring date-time nullable

Return events sent at or after this time, in ISO 8601 format. Must be within the last 7 days. Ignored if cursor is provided. If you omit both cursor and start_time, results start with the oldest retained event.

countinteger nullable

The maximum number of webhook events to return. Fewer events may be returned even when more are available; use has_more to determine whether to request another page.

webhook_typesstring[]

Return only events with these webhook types, for example ITEM. Case-sensitive.

webhook_codesstring[]

Return only events with these webhook codes, for example ERROR. Case-sensitive.

item_idsstring[]

Return only events for these Items.

delivery_statusesWebhookEventDeliveryStatus[]

Return only events with these delivery statuses.

Example request

{
  "webhook_types": [
    "ITEM",
    "AUTH"
  ],
  "webhook_codes": [
    "ERROR"
  ],
  "item_ids": [
    "abc123"
  ]
}

Response

OK

has_moreboolean required

Indicates whether another page of webhook events is available.

next_cursorstring required

The cursor to send as cursor in your next request. Store it even when has_more is false.

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Changes

  • ea443cd78f6fRevision changes
    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_REPORT_ERROR enum value to the response property for the response status

  • e536704a333fRevision changes
    • info

      endpoint added