docs: add FAQ for downloading crash attachments in bulk - #329
Open
bobbyg603 wants to merge 2 commits into
Open
Conversation
Documents both paths users ask about: the Download column in the app (hidden by default on the Crashes and Crash Group pages, enabled via Column Visibility) and scripting the Crashes + Crash endpoints to pull the pre-signed dumpfile zip that holds the crash file and attachments. Notes that API access needs an OAuth2 token with the restricted scope and a Business or Enterprise plan. Adds the annotated screenshot and the SUMMARY entry. Closes #328. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
…webhook Adds a danger callout capping Crash API polling at one request per second, repeats the limit inline in the download steps, and adds a "Get every crash with a webhook" section for anyone who needs more throughput than that. Warns that the webhook fires once per crash with no retries, so the endpoint has to keep up with peak crash volume. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #328
Adds
education/faq/how-do-i-download-crash-attachments-in-bulk.md, covering the three ways to get crash files and attachments out of BugSplat:.gitbook/assets/download-crash-attachments-column.png.dumpfilezip (crash file + all attachments) from Crash. A danger callout caps this at one request per second, and the limit is repeated inline in the download steps. A second hint notes API access requires an OAuth2 token with the restricted scope and a Business or Enterprise plan.crashFileUrlfrom a background queue).Also cross-links the single-file Attachments tab flow in Using the App, and adds the SUMMARY entry after the IP addresses FAQ.
Verification
The repo has no build, lint, or test tooling (GitBook-synced markdown, no
package.json/CI), so verification was a link audit:using-the-app.md#previewing-attached-files,crash.md#get-crash) and the same-page#get-every-crash-with-a-webhookanchor exist; all{% hint %}blocks are balanced.SUMMARY.mdentry still resolves, and every.mdfile in the repo is still listed inSUMMARY.md.Rendering was not checked in GitBook itself.
🤖 Generated with Claude Code