> For the complete documentation index, see [llms.txt](https://docs.notyfire.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.notyfire.io/readme.md).

# Welcome

## Welcome to the Notyfire Documentation

Welcome to the official documentation for **Notyfire**, a comprehensive platform designed to provide real-time visibility into crucial software delivery and organisational communication. This guide is designed to help users of all roles - from standard subscribers to system administrators - navigate and master the platform's features.

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th data-hidden data-card-cover data-type="image">Cover image</th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h3>Notifications flow</h3></td><td><a href="https://3397741173-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdrLTnMUrwW7mgtbMpCLm%2Fuploads%2FgXXw4fbrSHuxhtoAsu6f%2F05-20-notyfire-flow.png?alt=media&amp;token=6073d9aa-0d01-4654-9d7c-626c8b5133b5">05-20-notyfire-flow.png</a></td><td><a href="/key-concepts/notifications.md">Notifications</a></td></tr><tr><td><h3>Modules</h3></td><td><a href="https://3397741173-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdrLTnMUrwW7mgtbMpCLm%2Fuploads%2FVeivNysjjKoWu2S88OY3%2Fmodule%20announcements.png?alt=media&amp;token=e168157c-3c9f-4b03-b093-a954ca9608e0">module announcements.png</a></td><td><a href="/modules/overview.md">Overview</a></td></tr></tbody></table>

### Navigation Roadmap

Following the structure of this documentation, you can explore Notyfire through the following key sections:

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h4>Getting started</h4></td><td><mark style="color:$info;">Quickstart</mark></td><td>If you are new to the platform, begin here to hit the ground running.</td><td><a href="/getting-started/quickstart.md">Quickstart</a></td></tr><tr><td><h4>Key concepts</h4></td><td><mark style="color:$info;">Subscriptions</mark></td><td>The heart of Notyfire’s alerting logic is the <strong>Subscription</strong> system. Understand how to use <strong>Filters</strong> to link specific events to your preferred communication channels.</td><td><a href="/key-concepts/subscriptions.md">Key concepts</a></td></tr><tr><td><h4>Modules</h4></td><td><mark style="color:$info;">Overview</mark></td><td><strong>Notyfire</strong> is bifurcated into two distinct data streams to ensure you only focus on what is relevant to you.</td><td><a href="/modules/overview.md">Modules</a></td></tr><tr><td><h4>Roles</h4></td><td><mark style="color:$info;">Overview</mark></td><td>Explore specific documentation tailored to your assigned role in the system: <strong>Subscriber, Publisher, Developer, Manager, Admin.</strong></td><td><a href="/roles/subscriber.md">Roles</a></td></tr><tr><td><h4>Administration</h4></td><td><mark style="color:$info;">Instance configuration</mark></td><td>For technical users and system owners, these sections cover <strong>Instance Configuration</strong> and <strong>Integrations.</strong></td><td><a href="/administration/analytics.md">Administration</a></td></tr><tr><td><h4>API</h4></td><td><mark style="color:$info;">Authentication</mark></td><td>Technical references for <strong>Authentication</strong> and programmatic interaction with the Announcements and Development modules.</td><td><a href="/api/authentication.md">API</a></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.notyfire.io/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.