Manual error tracking installation

Learn the API schema

Required

Error tracking enables you to track, investigate, and resolve exceptions your customers face.

If a platform you use is not supported by error tracking, we recommend that you reach out to us or contribute to our open-source SDKs before attempting to manually send exceptions.

If you'd rather roll your own exception capturing (or if you're using a platform we don't have an SDK for), you can use the capture API or capture method to capture an $exception event with the following properties:

Property	Description
`$exception_list`	A list of exception objects with detailed information about each error. Each exception can include a type, value, mechanism, module, and a stacktrace with frames and type. You can find the expected schema as types for both exception and stack frames in our Rust repo
`$exception_fingerprint`	(Optional) The identifier used to group issues. If not set, a unique hash based on the exception pattern will be generated during ingestion

Make a request

Required

Example exception API capture:

Terminal
curl -X POST "https://us.i.posthog.com/i/v0/e/" \
     -H "Content-Type: application/json" \
     -d '{
        "api_key": "<ph_project_api_key>",
        "event": "$exception",
        "properties": {
            "distinct_id": "distinct_id_of_your_user",
            "$exception_list": [{
                "type": "RangeError",
                "value": "Maximum call stack size exceeded",
                "mechanism": {
                    "handled": true,
                    "synthetic": false
                },
                "stacktrace": {
                    "type": "raw",
                    "frames": [
                        {
                            "platform": "custom", // (Required) Must be custom
                            "lang": "javascript", // (Required) Your programming language
                            "function": "Array.forEach", // (Required)
                            "filename": "../loop.js", // (Optional)
                            "lineno": 1, // (Optional)
                            "colno": 2, // (Optional)
                            "module": "iteration", // (Optional)
                            "resolved": true, // (Optional)
                            "in_app": false, // (Optional)
                        },
                        /* Additional frames omitted for brevity */
                    ]
                }
            }],
            "$exception_fingerprint": "209842d96784e19321e3a36b068d53fff7a01ebcb1da9e98df35c4c49db0b4f3b62aea7ee25a714470e61f8d36b4716f227f241c153477e5fa9adfda64ce9f71"
        },
    }'

Verify error tracking
Recommended
Confirm events are being sent to PostHog
Before proceeding, let's make sure exception events are being captured and sent to PostHog. You should see events appear in the activity feed.
Check for exceptions in PostHog

Manual error tracking installation

Learn the API schema

Make a request

Verify error tracking

Community questions

Was this page useful?