Plaid sync started - Asset API Documentation

WEBHOOK

plaid_sync_started

{
  "type": "PLAID_SYNC_STARTED",
  "content": {
    "business_id": "biz_2xPQDLmNeWsrahR4bj3oGc9i6Nb",
    "account_id": "eac_3yQRENoPfXtsbhS5ck4pHd0j7Oc",
    "timestamp": "2024-01-15T10:30:00Z"
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Body

application/json

Webhook event sent when a Plaid sync starts.

type

string

required

The type of webhook event

Allowed value: "PLAID_SYNC_STARTED"

content

PlaidAccountEventContent · object

required

The event payload

Show child attributes

Response

Successful Response

⌘I

{
  "type": "PLAID_SYNC_STARTED",
  "content": {
    "business_id": "biz_2xPQDLmNeWsrahR4bj3oGc9i6Nb",
    "account_id": "eac_3yQRENoPfXtsbhS5ck4pHd0j7Oc",
    "timestamp": "2024-01-15T10:30:00Z"
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}