Skip to main content
GET
/
api
/
v1
/
webhook-events
List recent webhook events
curl --request GET \
  --url https://breadbox.example.com/api/v1/webhook-events \
  --header 'X-API-Key: <api-key>'
{
  "webhook_events": [
    {
      "id": "<string>",
      "provider": "<string>",
      "event_type": "<string>",
      "connection_id": "<string>",
      "institution_name": "<string>",
      "raw_payload_hash": "<string>",
      "status": "<string>",
      "error_message": "<string>",
      "created_at": "<string>"
    }
  ],
  "total": 123,
  "page": 123,
  "page_size": 123,
  "total_pages": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.breadbox.sh/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

X-API-Key
string
header
required

Breadbox API key with format bb_<base62>. Carries either read_only or full_access scope. Write endpoints (and a handful of sensitive reads — /api-keys, /users/{user_id}/login) require full_access; endpoints that require it are flagged in their description.

Query Parameters

provider
enum<string>
Available options:
plaid,
teller
status
enum<string>
Available options:
received,
processed,
error
page
integer
Required range: x >= 1
limit
integer
Required range: 1 <= x <= 200

Response

200 - application/json

Page of webhook events.

webhook_events
object[]
total
integer
page
integer
page_size
integer
total_pages
integer