Error codes
An Error code is one entry in Flowkiwi’s centralized error catalog. Every domain error and every validation violation the API returns is keyed to a catalog entry by its code and slug, so you can resolve a stable, localized message for anything the API reports.
When a write fails with a 422, each constraint violation carries a slug (and, for templated messages, a set of parameters). A domain error - a 404, for instance - carries a top-level code and slug. Look either up in this catalog to render a user-facing message in the caller’s language, rather than hard-coding one per error.
The message is localized from the Flowkiwi-Locale header; description stays in English for developers. This is a read-only reference resource: you list the catalog once and match incoming errors against it.
The Error code object
Section titled “The Error code object”| Property | Type | Required | Description |
|---|---|---|---|
code | string | - | Immutable UUID of the error. |
description | string | - | Technical English message (developer-facing, stable). |
domain | string | - | |
httpStatus | integer | - | |
message | string | - | User-friendly message in the request locale. |
slug | string | - |
Conventions
Section titled “Conventions”Authentication and headers
Section titled “Authentication and headers”All requests require an OAuth 2.0 bearer token:
Authorization: Bearer <token>Set the language you want message localized in:
Flowkiwi-Locale: fr-FRThis resource is read-only - it has no create, update or delete operations.