Open Notificaties Documentation
===============================

**Open Notificaties** is a modern, open-source messaging service that implements the
`VNG API standard for the "Notificaties API"`_ in line with the `Common Ground`_ model.
Among others, it can be used in combination with `Open Zaak`_ which implements the
`VNG standards for "API's voor Zaakgericht werken"`_ that require a Notificaties API.

.. _`Common Ground`: https://commonground.nl/
.. _`Open Zaak`: https://github.com/open-zaak/open-zaak/
.. _`VNG API standard for the "Notificaties API"`: https://vng-realisatie.github.io/gemma-zaken/standaard/notificaties/
.. _`VNG standards for "API's voor Zaakgericht werken"`: https://vng-realisatie.github.io/gemma-zaken/standaard/

Getting Started
---------------

To get you started, you might find some of these links relevant:

* New to Open Notificaties? Have a look at the :ref:`introduction_index`
* New to the VNG standards for "API's voor Zaakgericht werken"? Read up on the
  :ref:`api_index`.
* Want to get started with Open Notificaties yourself? See :ref:`installation_index`.
* Need help with Open Notificaties? Contact :ref:`support_index`.
* Are you a developer? Head over to :ref:`development_index`!

Open Notificaties `is`_ and only uses :ref:`introduction_open-source`.

.. _`is`: https://github.com/open-zaak/open-notificaties/blob/main/LICENCE.md

.. toctree::
   :maxdepth: 3
   :hidden:

   introduction/index
   api/index
   installation/index
   manual/index
   support/index
   delivery_guarantees
   development/index
   changelog