# Zammad integration

Zammad is an open-source helpdesk system that lets you manage all communication channels of your company from the same platform. Thanks to the REST API, Zammad can easily be integrated into existing system environments.

Connect sipgate and Zammad and benefit from automatic contact synchronization. All changes or new contacts you add in the sipgate app during or after the call are automatically saved in Zammad.

**Integration of Zammad into the sipgate app:**

{% stepper %}
{% step %}
**Select integration**

Click the gear icon on the left in the sipgate app and select the item **Integrations** from.\
Under the item **Integrations** look for the entry **Zammad** and click the button **Connect with Zammad**. ![](/files/724c4de25e5304dbde77237cb34cd0b5882d9aeb)
{% endstep %}

{% step %}
**Enter API data**

Enter the required API key and API URL here.

![](/files/dbba9ea5e551a6086c92d013e9952296572616fe)
{% endstep %}

{% step %}
**Confirm connection**

You have successfully connected Zammad and the sipgate app.

{% hint style="info" %}
Note: Depending on the number of contacts to be integrated, it may take a few minutes before they are displayed completely.
{% endhint %}
{% endstep %}
{% endstepper %}

**Find or create API key in your Zammad account:**

In your account, click the user icon in the lower left corner and select "Profile".

![Zammad1](/files/f1d50768d6e40f0ed56b7abfd4eb7c76f2665e68)

Now open the "Token Access" menu item and click the "Create" button.

![Zammad2](/files/bd28c1f424177be462cf10d3caebce684dab21eb)

Now assign a name for the API key to be created **and select the option "User, Manage Users" from the list.**

![Zammad3](/files/461dd2d705c78f0b82362f81f07d8c499ceee9d0)

You have now created the required API key. Please copy this key and enter it accordingly in the sipgate app.

{% hint style="warning" %}
Important: To enable creating and updating call logs/notes, add the following permissions to the API key:
{% endhint %}

* **admin.user**
* **admin.organization**
* **ticket.agent**

![Zammad4](/files/a146436ad0308a3775f3e778b5df45e33924bec1)

{% hint style="warning" %}
**Important:** To enable the self-hosted Zammad CRM solution in your firewall setup, you must allow the Zammad bridge at zammad.bridge.clinq.com and port 443. This is required so that the sipgate app can successfully load the CRM contacts.
{% endhint %}

#### Create contacts

The sipgate app always writes new contacts or changes contact entries in Zammad in the role **Customer.** This role exists in Zammad by default, but can be changed. If this role does not exist because the name has been overwritten, or if there are other roles, the sipgate app cannot write to the intended role.

#### Notes for self-hosted Zammad solution

The sipgate<>Zammad bridge uses the following APIs to sync contacts and create call events:

* Endpoints under /api/v1/users
* Endpoints under /api/v1/organizations
* Endpoints under /api/v1/tickets\
  \&#xNAN;*Zammad API:* [Introduction — Zammad System Documentation documentation](https://docs.zammad.org/en/latest/api/intro.html#endpoints-and-example-data)\
  \&#xNAN;*Zammad API – User:* [User — Zammad System Documentation documentation](https://docs.zammad.org/en/latest/api/user.html)

The Zammad CTI API is not used because it is not possible to process live events with it:\
\&#xNAN;*Zammad Generic CTI API:* [Generic CTI — Zammad System Documentation documentation](https://docs.zammad.org/en/latest/api/generic-cti/)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.sipgate.de/cloud-telefonanlage/en/connections-and-integrations/integrationen-fur-die-sipgate-app/zammad-integration.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.