Contao Anbindung an Zammad

[contaoacademy/contao-zammad-nc-api-bundle]

API Anbindung zum Helpdesk-System Zammad über ein Gateway des Notification-Centers. Die Schnittstelle sendet Formulardaten direkt als neues Ticket an Zammad. Falls ein Kontakt in Zammad nicht angelegt ist, wird dieser ebenfalls erzeugt.

Aktueller Funktionsumfang

  • Neue Support-Tickets über das Notification-Center erzeugen
  • Fehlende Kontakte automatisch erzeugen
  • Übertragen zusätzlicher Daten an das Ticket

Weitere Funktionen sind für zukünftige Versionen geplant. Du kannst die Weiterentwicklung gerne unterstützen. Hier findest du die Erweiterung bei GitHub.

Voraussetzungen

So setzt du die Erweiterung ein

1. Installation

Die Erweiterung kann kostenlos über den Contao Manager installiert werden. Suche dazu nach der Erweiterung contaoacademy/contao-zammad-nc-api-bundle.

2. API-Zugriff und Zugriffs-Zoken in Zammad aktivieren

  1. Zammad einloggen mit Adminrechten
  2. Einstellungen (Zahnrad) > System > API
  3. Token-Zugriff (HTTP Token Authentication) aktivieren
  4. Neuen Zammad-Benutzer anlegen bzw. bestehenden User verwenden
  5. Benutzer > Profil > Token-Zugriff > Erstellen Button klicken
    Berechtigungen: ticket.agent
    Persönlicher Access Token zwischenspeichern!

3. Zammad Zugangsdaten bei Contao hinterlegen

System > Einstellungen > Zammad-Einstellungen

  • Authentication Type = Token
  • Host = URL zu Zammad Instanz
  • Token = Persönlicher Token aus Schritt 2

4. Neues Gateway anlegen

Notification Center > Gateways > Neues Gateway

    • Titel: Zammad (oder jeder beliebige Name)
    • Typ: Zammad-API

5. Neue Benachrichtigung anlegen

Notification Center > Benachrichtigungen > Neue Benachrichtigung

6. Nachricht erstellen

Bei der soeben erzeugten Benachrichtigung muss nun eine Neue Nachricht erstellt werden.

  • Titel = Zammad-Ticket (bzw. frei wählbar)
  • Gateway = Zammad
  • Zammad Gruppe = Gruppe aus Zammad (werden die Tickets zugeordnet)

7. Formular erstellen

Erstelle ein entsprechendes Formular über den Formulargenerator. Bei Formulardaten versenden stellst du die vorher erstelle Benachrichtigung ein.

Damit die Zuordnung zu Zammad korrekt funktioniert, gibt es bestimmte Pflichtfelder mit vorgegebenen Namen:

Pflichtfelder:

  • firstname = Vorname
  • lastname = Nachname
  • subject = Titel des Tickets
  • email = E-Mail-Adresse
  • body = Ticket Inhalt

Zusätzliche Felder

  • mobile = Mobilnummer
  • phone = Telefonnummer
  • web = Website
  • address = Adresse
  • note = Notiz
  • department = Abteilung

Weitere Felder und Daten:

Im body wird automatisch der Alias der Seite ergänzt. Außerdem werden weitere Felder, für die keine feste Zuordnung vorgegeben ist, im Formular automatisch am Ende des Tickets dem body hinzugefügt.

Credits