Documentation

Welcome to the TipOff documentation.

Getting Started

• Introduction — what TipOff is and how it works
• Quick Start — send your first notification in minutes

Guides

• Sending Notifications — notification payload reference
• Action Delivery — webhooks, SSE, gRPC agent, polling
• Agent Adapters — YAML adapter system with expression interpreter

Reference

• REST API (opens in new tab) — full endpoint documentation
• Configuration — environment variable reference
• Adapter Schema — complete field reference for adapter YAML files
• Example Adapters — annotated production adapters for Donetick and Vikunja