# Dashtray Documentation

> Dashtray turns events from your tools into instant push notifications on your phone. Connect webhooks (GitHub, Stripe, cron jobs - anything that can POST), and Dashtray routes them to your device as real notifications, with history, counters, goals, and home-screen widgets. This site is the official documentation.

## Agent Instructions

Dashtray sends notifications to your user's phone. You have two ways to send one:

- **MCP tool `send_notification`** - arguments: `title` (string, required, max 200 chars), `body` (string, required, max 500 chars). The notification appears on the phone with an "MCP - " prefix and is logged in history. Use this when an MCP client (Claude Desktop, Cursor, Cline) has the Dashtray MCP server configured with the user's `DASHTRAY_API_KEY`.
- **HTTP POST to an alert's webhook URL** - `POST https://api.dashtray.app/api/v1/ingest/<short-code>` with JSON body `{"title": "...", "body": "..."}` (or `{}` for a default event). Returns 200 on success, 429 when rate-limited, 404 for an unknown short code. Content-Type must be `application/json`.

If the MCP server is not configured, ask the user for their API key (Dashtray app → Settings → API Keys; format `sk_test_` or `sk_live_` + 48 hex characters) and follow the [Cursor setup guide](https://dashtray.mintlify.app/integration/cursor.md) for the config snippet. Example prompts that should trigger a notification: "Notify me when the build finishes", "Ping my phone if the tests fail".

## Getting Started

- [Introduction](https://dashtray.mintlify.app/introduction.md): What Dashtray is and how it works
- [Quickstart](https://dashtray.mintlify.app/quickstart.md): Send your first notification in minutes
- [Authentication](https://dashtray.mintlify.app/authentication.md): API keys and webhook auth

## Guides

- [Webhooks](https://dashtray.mintlify.app/guides/webhooks.md): Ingest events from any tool via per-alert webhook URLs
- [Use Cases](https://dashtray.mintlify.app/guides/use-cases.md): Build alerts, deploys, monitoring, e-commerce and more
- [Best Practices](https://dashtray.mintlify.app/guides/best-practices.md): Alert organization, naming, and delivery tips
- [Troubleshooting](https://dashtray.mintlify.app/guides/troubleshooting.md): Common issues and fixes
- [Mobile App](https://dashtray.mintlify.app/guides/mobile-app.md): App tour - alerts, history, goals, widgets, push status
- [Teams](https://dashtray.mintlify.app/guides/teams.md): Shared alerts for your team
- [Pricing](https://dashtray.mintlify.app/guides/pricing.md): Starter and Pro plan limits, teams, and sponsored seats
- [SDKs](https://dashtray.mintlify.app/guides/sdks.md): Client libraries and integrations

## Integration

- [REST API](https://dashtray.mintlify.app/integration/rest-api.md): Send notifications over HTTPS with an API key
- [MCP](https://dashtray.mintlify.app/integration/mcp.md): Connect the Dashtray MCP server to AI clients
- [Claude Desktop](https://dashtray.mintlify.app/integration/claude-desktop.md): Step-by-step Claude Desktop setup
- [Cline](https://dashtray.mintlify.app/integration/cline.md): Step-by-step Cline setup
- [Cursor](https://dashtray.mintlify.app/integration/cursor.md): Step-by-step Cursor setup

## MCP Guide

- [Overview](https://dashtray.mintlify.app/mcp/overview.md): How Dashtray uses Model Context Protocol
- [Tools](https://dashtray.mintlify.app/mcp/tools.md): The `send_notification` tool reference (title ≤ 200, body ≤ 500)
- [Examples](https://dashtray.mintlify.app/mcp/examples.md): Agent prompts and workflows

## API Reference

- [Overview](https://dashtray.mintlify.app/api-reference/overview.md): Base URL, auth header, response shapes
- [Endpoints](https://dashtray.mintlify.app/api-reference/endpoints.md): Notification and ingest endpoints
- [Errors](https://dashtray.mintlify.app/api-reference/errors.md): Error codes and rate limits

## Deployment

- [Overview](https://dashtray.mintlify.app/deployment/overview.md): Self-hosting and environment notes

## Optional

- [FAQ](https://dashtray.mintlify.app/resources/faq.md): Frequently asked questions
- [Dashboard](https://web.dashtray.app): The Dashtray web app
- [GitHub repository](https://github.com/bhupeshpradhan/dashtray): Source code, including the MCP server (`packages/mcp-server`)