Skip to content

Envelope and Errors

Success envelope

json
{
  "data": {},
  "meta": {},
  "error": null
}

Error envelope

json
{
  "data": null,
  "meta": {},
  "error": {
    "code": "API_PAYLOAD_INVALID",
    "message": "...",
    "hint": "..."
  }
}

Response headers

  • x-request-id: request correlation ID on responses.
  • x-zeptoz-error-code: present on Zeptoz error responses.

Hook warning metadata

For after_* hook failures/timeouts, response can include:

json
{
  "meta": {
    "hook_warnings": [
      {"code": "HOOK_RUNTIME_TIMEOUT", "message": "..."}
    ]
  }
}