API

Basics

Send a batch of errors

POST /v1/errors with {"events": [...]}: up to 100 events, and gzip with Content-Encoding: gzip if you like. Scrub personal data before you send it; Errors scrubs again on arrival.

Optional fields may be left out or null. context takes free-form JSON, shown on the event; its tags (string to string) feed an issue's What differs. A context over 64 KB is cut down to its tags.

curl https://services.my-beast.com/errors/v1/errors \
  -H "Authorization: Bearer $MYBEAST_ERRORS_SECRET" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "events": [{
      "event_id": "0193f1c2-5b7e-7a41-9d2e-6f3c1a8b9e04",
      "occurred_at": "2026-11-01T09:14:03.120+00:00",
      "platform": "other",
      "level": "error",
      "exception_class": "KeyError",
      "message": "missing key: plan",
      "exceptions": [{
        "class": "KeyError",
        "message": "missing key: plan",
        "frames": [
          { "file": "app/billing.py", "line": 42, "function": "charge", "in_app": true }
        ]
      }],
      "environment": "production",
      "release": "4f2a9c81d0e3",
      "transaction": "POST /checkout",
      "subject": "1042"
    }]
  }'

{
  "accepted": 1,
  "duplicates": 0,
  "refused": []
}

The answer counts each event: accepted, duplicates (an event_id sent before, stored once) and refused, each with its event_id and reason. A refused event never fits: don't send it again. Past the project's monthly limit the rest are refused with the reason monthly-limit until the 1st (UTC). An event older than the project keeps events is refused; one from the future is placed at now.

Say the app can reach Errors

POST /v1/checkins. Send one an hour, so an environment with no errors can be told from one that can't reach Errors: an environment heard before and silent for 3 hours is reported as gone quiet.

curl https://services.my-beast.com/errors/v1/checkins \
  -H "Authorization: Bearer $MYBEAST_ERRORS_SECRET" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"environment": "production", "sdk": "billing-worker", "sdk_version": "1.4.0", "release": "4f2a9c81d0e3"}'

{
  "heard": true,
  "project": "shop",
  "environment": "production"
}

Mark a release live

POST /api/v1/releases with version (1 to 64 of A-Z a-z 0-9 . _ + -) and environment, once the release serves requests there. The "it's fixed" notices waiting for a newer release go out, and notified says to how many people (Tell the people it hit).

curl https://services.my-beast.com/errors/api/v1/releases \
  -H "Authorization: Bearer $MYBEAST_ERRORS_SECRET" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"version": "4f2a9c81d0e3", "environment": "production"}'

{
  "version": "4f2a9c81d0e3",
  "environment": "production",
  "notified": 2
}

Upload a source map

PUT /api/v1/releases/{version}/files/sourcemap/{name}, the map's raw bytes as the body. name is the bundle's file name with .map, such as app-3fA9xQ1z.js.map. A map must be JSON, up to 20 MB. Upload it before the release's errors arrive: a stack is mapped when the error comes in (Source maps).

curl -X PUT https://services.my-beast.com/errors/api/v1/releases/4f2a9c81d0e3/files/sourcemap/app-3fA9xQ1z.js.map \
  -H "Authorization: Bearer $MYBEAST_ERRORS_SECRET" \
  -H "Accept: application/json" \
  --data-binary @storage/app/private/sourcemaps/app-3fA9xQ1z.js.map

{
  "name": "app-3fA9xQ1z.js.map",
  "size": 482113,
  "sha256": "9c1f…"
}

Erase a person

DELETE /api/v1/subjects/{subject}: every error event of that person, what your app was asked to tell them, their entries in webhook deliveries, and a mark of them as your own. erased counts the rows that went or were emptied; erasing again answers 0. The project's audit log records the erasure, never the id.

curl -X DELETE https://services.my-beast.com/errors/api/v1/subjects/1042 \
  -H "Authorization: Bearer $MYBEAST_ERRORS_SECRET" \
  -H "Accept: application/json"

{
  "erased": 37
}

Erase an account

DELETE /api/v1/accounts/{account}: every error event of that account, whoever it happened to, and its people in webhook deliveries. Answered as erasing a person.

Errors

A 5xx or a timeout is worth trying again: an event sent twice with the same event_id is stored once. The browser SDK and the Laravel SDK's performance samples use two more paths, /v1/browser-errors and /v1/transactions; they are the SDKs' own.