HTTP API

The public collector uses a project ingest key. Dashboard APIs use the authenticated user's bearer token or, for specific browser forms, the BugHQ session cookie.

Ingest an error

POST /errors
Content-Type: application/json
X-BugHQ-Key: bughq_your_project_key

{
  "message": "Checkout failed",
  "type": "PaymentError",
  "stack": "PaymentError: Checkout failed\n    at submitOrder (checkout.ts:42:9)",
  "environment": "production",
  "release": "checkout@2.14.0",
  "url": "https://example.com/checkout",
  "user": { "id": "usr_42" },
  "tags": { "region": "us-west" },
  "extra": { "orderId": "ord_123" },
  "breadcrumbs": []
}

The message is required. The key can also be sent in the body. The collector rejects payloads above 256 KiB, applies rate limits, and returns 401, 413, or 429 when authorization or limits fail.

Native events

iOS and Android SDKs add platform (ios or android) and a structured exception. Frames are top of the stack first. An Apple frame names its binary, the binary's UUID and the offset into it, which the ingest symbolicates with uploaded symbols. A JVM frame names its class, method, file and line, which the ingest retraces with an uploaded R8 mapping.

{
  "platform": "ios",
  "type": "SIGTRAP",
  "message": "Fatal error: Unexpectedly found nil while unwrapping an Optional value",
  "level": "fatal",
  "release": "1.0.0+41",
  "session": { "id": "5c2f…", "startedAt": "2026-10-14T18:00:00.000Z" },
  "contexts": { "app": { "version": "1.0.0", "build": "41" }, "device": { "model": "iPhone17,1" } },
  "exception": {
    "mechanism": "signal",
    "handled": false,
    "frames": [
      { "image": "MyApp", "image_uuid": "F47C8145-F263-379D-9AD1-F3485CB38B7F", "image_offset": 2752, "in_app": true }
    ]
  }
}

Sessions

POST /sessions
Content-Type: application/json
X-BugHQ-Key: bughq_your_project_key

{ "sessions": [{ "id": "5c2f…", "release": "1.0.0+41", "status": "ok", "started_at": "2026-10-14T18:00:00.000Z" }] }

One session per app launch, for crash-free sessions. A batch of up to 50 is accepted, so a device can replay its offline queue in one request. status is ok, errored, abnormal or crashed and only escalates. Sessions are not metered.

Debug files

POST /api/debug-files?kind=apple
POST /api/debug-files?kind=proguard&release=1.0.0%2B41
Authorization: Bearer bughq_up_your_upload_token

The body is the output of symbols -arch arm64 <dSYM> or an R8 mapping.txt, gzipped or plain, up to 64 MiB. The upload token is a secret created in project settings; the ingest key is refused. A re-upload for the same binary UUID or release replaces the earlier one.

Service and SDK endpoints

Issue APIs

Project APIs

Members and channels

The dashboard API is an application interface and may evolve before the first stable release. Custom integrations should pin a compatible BugHQ version and test response shapes during upgrades.