Skip to content

Document X-Zammad-Suppress-Notifications header for ticket update API #862

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dominikklein wants to merge 1 commit into
base: pre-release
Choose a base branch
from
+17 −0
Open

Document X-Zammad-Suppress-Notifications header for ticket update API #862

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions api/ticket/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,23 @@ Update

Required permission: ``ticket.agent`` **or** ``ticket.customer``

.. tip::

**🔕 Suppress notifications**

To update a ticket without triggering agent notifications (email and
in-app), add the following HTTP header to your request::

X-Zammad-Suppress-Notifications: true

This is useful for automated integrations that update tickets via
webhooks or triggers to avoid notification loops. The header is
available to **agents and admins only** — it is silently ignored

@ralf401 ralf401 Jun 23, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't really get this. The header can be used by any third-party app/client. But notifications are only suppressed for agents and admins, right? Maybe phrase it like The header only affects admin and agent accounts and is ignored for customers? Just an idea.

for customers.

The header also works on the ``POST /api/v1/ticket_articles``
endpoint and the GraphQL ``ticketUpdate`` mutation.

@ralf401 ralf401 Jun 23, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Currently, we don't have GraphQL mentioned at all in the docs. This is just related to the new stack, right? Maybe we could omit this part, if it's ok from your side?


``PUT``-Request sent: ``/api/v1/tickets/{ticket id}``

.. code-block:: json
Expand Down
Loading