Webhooks

Plaid Webhook Endpoint

    Receives webhook notifications from Plaid when transaction data becomes available
    or when other events occur. This endpoint processes the webhook and triggers
    appropriate background tasks to sync transaction data.

    **Supported Webhook Types:**
    - `TRANSACTIONS.INITIAL_UPDATE`: Transaction data is ready for a new connection
    - `TRANSACTIONS.DEFAULT_UPDATE`: New transactions are available
    - `TRANSACTIONS.HISTORICAL_UPDATE`: Historical transaction data updated
    - `ITEM.ERROR`: Item-level errors occurred
    - `ITEM.PENDING_EXPIRATION`: Access token expiring soon

    **Security:** This endpoint is configured to accept webhooks from Plaid's servers.
    
post/bth/webhook/plaid/

Request

  • Base URL
    https://docs.thredfi.com (the document declares no server; this is the origin it was published from)
  • Auth
    • HTTP basic
    • or HTTP bearer
    • or HTTP bearer

Request body

webhook_type'TRANSACTIONS' | 'ITEM' | 'AUTH' | 'IDENTITY' required

Type of webhook event

webhook_code'INITIAL_UPDATE' | 'DEFAULT_UPDATE' | 'HISTORICAL_UPDATE' | 'ERROR' | 'PENDING_EXPIRATION' required

Specific webhook event code

item_idstring required

Plaid item ID that triggered the webhook

Response

Webhook processed successfully

string required

Changes

No recorded changes to this operation across all 1 revision of this API.