DOCSEARCHbyAlgolia
Submit Docs

Shake Documentation

website·Indexed 35 days ago

https://docs.shakebugs.com/docs

Guides and API references for integrating Shake into Android, iOS, Flutter, and Web applications. Features include bug reporting, crash reports, user feedback, live chat, and automatic screen recording and screenshot attachments (Black box).

Tokens
73.4K
Snippets
330
Records
568
Agent score
59%

What's inside Shake

  1. Overview of Shake User Feedback module

    The User Feedback module allows users and testers to report feedback seamlessly. It integrates with Shake's configuration and data settings to automatically attach screenshots and activity history to submitted tickets without requiring additional code.

  2. Overview of Shake React Native SDK modules

    The Shake React Native SDK consists of two primary modules that can be used independently or together:

    1. User Feedback: Allows testers and users to send bug reports, questions, and suggestions.
    2. Users: Provides a list of all app users, their attributes, reported tickets, and live chat functionality.

  3. Overview of Shake Users module

    The Users module allows developers to track app users, their custom attributes, and their submitted tickets via the Shake dashboard. Key features include:

    • App users can view their previously submitted tickets on the Home screen.
    • Centralized user listing on the Shake dashboard.
    • Automatic tracking of custom user attributes.
    • Support for live chat between the developer and app users.

  4. Overview of Shake Android custom forms

    Shake provides a default feedback and crash reporting form that includes a mandatory Title, a Feedback type selector (bug, question, suggestion), an Inspect button for data review, and an Attachments option. Developers can replace or modify this by creating a custom form using specific Shake form components. Note that the Title, Inspect button, and Attachments elements can only be added to the form once; if multiple instances are included, only the first will be displayed.

  5. Overview of Shake MCP server capabilities

    The Shake MCP server allows AI agents to interact with Shake tickets, crashes, and end users. It supports reading and searching records, triaging and updating tickets, replying to reporters, and managing app setups and workspace members directly from an editor. Access is controlled via two OAuth scopes: mcp:read for discovery and search, and mcp:write for data modifications.

  6. Overview of Shake Crash reports for Android

    The Crash reports module tracks crashes and uncaught exceptions in Android applications. These reports are intelligently grouped on the Shake dashboard and include contextual data such as auto-screenshots, auto-screen recordings, and activity history (inherited from the general Configuration and data settings). When a user re-opens the app after a crash, developers can choose to receive the report silently or prompt the user for an additional description.

  7. Use the Shake Drawing screen to annotate ticket images

    The Drawing screen allows users to draw on images attached to a ticket or blur specific parts of an image for privacy or emphasis. Users access this screen by tapping any image attached to their ticket while on the New ticket screen.

  8. Understand the Shake default feedback form

    Shake provides a pre-designed default feedback form for collecting user input. It includes:

    • Title: A mandatory field for a short description of the issue.
    • Feedback type: A selection for categorizing the ticket as a bug, question, or suggestion.
    • Attachments: An option for users to attach screenshots or video recordings.

  9. Enable and manage live chat for app users

    The Shake chat feature allows app users to provide additional details about reported bugs, crashes, or feedback. Chat is enabled automatically once an app user is registered with Shake. Each ticket submitted by a user initiates a separate conversation.

    Note that chat connectivity is tied to the user's registration lifecycle: calling Shake.unregisterUser will disconnect the current app user from chat, and they will not receive new messages until they are registered again.

  10. Enable Shake Chat for iOS

    The chat feature is enabled automatically once an app user is registered. Each ticket sent by a user creates a separate conversation. Note that calling Shake.unregisterUser disconnects the user from chat, and they will stop receiving messages until they are registered again.

  11. Use Shake MCP server for AI-driven ticket management

    The Shake MCP (Model Context Protocol) server allows AI agents (such as ChatGPT, Claude, Cursor, and Windsurf) to interact with Shake data. Supported tasks include:

    • Ticket Analysis: Understanding issues via URLs, analyzing screenshots/videos, and retrieving session replays.
    • Discovery: Finding new crashes by platform (e.g., Android), filtering open tickets by version or tag, and identifying frequent reporters.
    • Workflow Automation: Triaging tickets, assigning users, changing statuses (e.g., 'In progress'), adding internal notes, and drafting user replies.
    • Release Monitoring: Checking version health and notifying users after a fix is shipped.

    Safety Note: Actions that impact real people (replies, notifications) or delete tickets are previewed for approval before being executed.

  12. Connect Cursor to Shake workspace via MCP

    To connect Cursor to your Shake workspace, you can install the MCP Server. This allows you to ask Cursor questions about your Shake tickets. You can install it via the provided deep link or manually by configuring the mcp.json file.
    {
  "mcpServers": {
    "shakebugs": {
      "url": "https://mcp.shakebugs.com/mcp",
      "headers": {}
    }
  }
}