Skip to content

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

Open
dominikklein wants to merge 1 commit into
pre-releasefrom
dk/issue-6042-suppress-notifications-header
Open

Document X-Zammad-Suppress-Notifications header for ticket update API#862
dominikklein wants to merge 1 commit into
pre-releasefrom
dk/issue-6042-suppress-notifications-header

Conversation

@dominikklein

Copy link
Copy Markdown
Contributor

Summary

Documents the new X-Zammad-Suppress-Notifications: true HTTP header introduced in zammad/zammad#6042.

Adds a tip block to the Update section of the Tickets API page explaining:

  • How to use the header to suppress agent notifications (email + in-app)
  • That it targets automated integrations to avoid notification loops
  • Permission scope: agents and admins only, ignored for customers
  • That the same header works on POST /api/v1/ticket_articles and the GraphQL ticketUpdate mutation

Related

@github-actions

Copy link
Copy Markdown

Artifacts

Produced during runtime

📦 html-86ca9c1

@dominikklein

Copy link
Copy Markdown
Contributor Author

@ralf401 @fliebe92 Maybe you can have a look.

Comment thread api/ticket/index.rst
for customers.

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

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?

Comment thread api/ticket/index.rst

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

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants