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
}Webhooks
List recent webhook events
Paginated list of inbound provider webhooks (event_type, status,
connection_id, institution name, created_at). Filters: provider,
status, page, limit (max 200).
Requires full_access scope.
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
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
Available options:
plaid, teller Available options:
received, processed, error Required range:
x >= 1Required range:
1 <= x <= 200⌘I