Skip to content

// integration

Zammad

Applies to

Product: Cloud · Server · Audience: Administrator

The Zammad connector lets the basebox assistant search and read the tickets and knowledge base of your Zammad help desk. It changes nothing. With personal sign-in the assistant only reaches tickets and answers the person may see in Zammad.

What does the connector do?

Beta

The connector is work in progress. Only organisations with beta features switched on see it.

This and the following sections are generated from the information the connector's image carries. What applies to every connector is described under What applies to every connector.

In the catalog it describes itself as:

Search the tickets and knowledge base of your Zammad help desk. With per-user access tokens the assistant only reaches tickets and answers that user may see.

It gives the assistant these instructions:

Zammad is the organisation's help desk. To answer how a problem is solved, search both the knowledge base and past tickets, then read the most promising hits in full. Cite a ticket by its number and an answer by its title. Every call runs with the current user's own Zammad account, so results contain only what that user may see; a permission error means the user lacks access, not that the item does not exist.

Settings

The administrator fills in these fields in the connector's settings. They apply to the whole organisation.

Field Required Meaning
Zammad URL no The Zammad web root every request goes to, as users open it in the browser. Example: https://support.example.org
Help link for signing in no Where users can read how to create their Zammad access token, e.g. a page on your intranet.

Sign-in

The administrator decides how the connector signs in: with Personal sign-in each person signs in with their own account and sees only what they may. With Company account everyone uses one account the administrator enters.

Personal sign-in

  • Zammad access token – asks for a token. In Zammad, open your avatar → Profile → Token Access and create a token with the permissions ticket.agent and knowledge_base.reader.
  • Zammad login – asks for a username and password. Your Zammad email address or login and your password.

Company account

  • Zammad service account token – asks for a token. An access token of a dedicated Zammad agent, limited to ticket.agent and knowledge_base.reader and to the groups everyone may see.

A company account gives everyone the same rights

Every basebox user reaches the system with the rights of this one account. Results are not trimmed to what each person may see.

The connector adds:

Zammad trims every result to the groups and knowledge base permissions of the signed-in account. A shared account flattens that: every basebox user will see whatever that one account can see, internal notes included.

Tools

The assistant can call 5 tools.

Tool Effect Description
get_current_user reads Read the account the current user is connected to Zammad, the organisation's help desk, with: name, roles and the groups it has access to.
get_knowledge_base_answer reads Read the full text of one answer from the knowledge base of Zammad, the organisation's help desk. Fails if the current user may not see the answer.
get_ticket reads Read one support ticket in Zammad, the organisation's help desk, with all its messages, oldest first. Messages marked internal are for agents only; never quote them to a customer. Fails if the current user may not see the ticket.
search_knowledge_base reads Search the answers in the knowledge base of Zammad, the organisation's help desk. Returns one page of hits, each with title, a short excerpt and a url holding the ids needed to read the whole answer. Only answers the current user may see are returned.
search_tickets reads Search the support tickets in Zammad, the organisation's help desk, by words or ticket fields. Returns one page of matching tickets without their messages, and the total number of matches. Only tickets the current user may see are returned.

Generated from mcp-zammad:v0.1.1.