Quickstart
Move one project notification out of chat and into FYInbox for people and agents with a source API key and a single HTTP request.
Project notifications out of chat
Documentation
Send project activity to one inbox for people and agents, then add identity, metadata, tags and safe actions. Human documentation and machine-readable contracts describe the same notification system.
Concepts
Understand the small set of account, source, notification, tag, metadata, action, and push concepts used by the product.
API authentication
Authenticate producer and agent requests with a source-scoped bearer key while keeping the secret out of clients, payloads, logs, and source control.
Notification payload
Start with a title, then add severity, body, tags, metadata, event identity, timestamp, and safe link actions only when useful.
Deduplication and retries
Give each logical event a stable source-scoped key so a network retry cannot create a second inbox item while the original is retained.
FYInbox TypeScript SDK
Use the server-only TypeScript client for runtime validation, bounded responses, safe errors, deadlines, and conservative retry behavior.
Errors and retries
Branch on HTTP status and stable error code, preserve unknown codes, honor Retry-After, and avoid replaying ambiguous non-idempotent mutations.
Limits
Design producers below the public protocol ceilings and expect the running deployment or account policy to enforce lower operational values.
API reference
Use the versioned API for notification creation, agent-readable notification context, and scoped metadata mutation; dashboard and account endpoints are not public APIs.
Security and privacy
Minimize notification data, keep producer credentials server-side, and understand what the managed service must decrypt to provide inbox and filtering features.
Compatibility policy
Integrate against the versioned contract, accept additive response evolution, and use stable error codes and schemas instead of dashboard internals.
Changelog
Track public producer API, machine-contract, SDK, and documentation changes without mixing in private dashboard implementation details.
Machine-readable contracts for agents
The same contract is available as OpenAPI, JSON Schema, concise discovery text and full deterministic Markdown. These are the canonical interfaces for the operations documented here.