Skip to main content
Preview rule matches

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.

Body

application/json
name
string
required
condition
object
required
actions
object[]
required
enabled
boolean
priority
integer
triggers
enum<string>[]
Available options:
sync,
retroactive,
manual

Response

200 - application/json

Preview matches.

The response is of type object.

Last modified on June 25, 2026