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. Zugriffs-Zoken in Zammad erstellen

  1. Bei Zammad mit Adminrechten anmelden
  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. Neues Gateway erstellen

Notification Center > Gateways > Neues Gateway

  • Typ: Zammad-API
  • Host = URL zu Zammad Instanz
  • Token = Persönlicher Token aus Schritt 2

4. Neue Benachrichtigung anlegen

Notification Center > Benachrichtigungen > Neue Benachrichtigung

5. Nachricht erstellen

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

  • Titel = Zammad-Ticket (bzw. frei wählbar)
  • Gateway = Zammad
  • E-Mail Adresse = Feld für E-Mail-Adresse (z. B. ##form_email##)
  • Kunden-Parameter = Wird nur für neue Kontakte verwendet. Felder können nach Bedarf ergänzt werden. Empfohlen ist min. Vorname (firstname) und Nachname (lastname). Mögliche Felder siehe in der Doku der Zammad-API.
  • Ticket-Titel = Text bzw. Simple Token
  • Ticket-Gruppe = Zammad-Gruppe zu der das Ticket zugeordnet wird
  • Nachricht = Inhalt des Tickets. Kann beliebigen Text, Insert-Tags und Simple Tokens enthalten

6. Formular zuordnen

Beim gewünschten Formular muss jetzt noch die passende Benachrichtigung zugeordnet werden.

Credits