Zammad Gateway is an excellent tool for those who want to integrate Zammad with external systems but don't have the knowledge or time to develop a custom integration.
It is an intermediate API that encapsulates/handles the authentication and requests to the Zammad Helpdesk API (like a wrapper) and exposes some endpoints to interact with them. The Gateway is a straightforward and effective way to integrate Zammad with third-party systems.
This software can be installed on a server and configured to listen for incoming requests from external systems. It then forwards those requests to Zammad using the Zammad Helpdesk API.
Magento |
![]() Stay tuned! |
The requirements are:
To use Zammad Gateway you need to have a Zammad instance up and running. You can install it using the Zammad installation guide.
Docker and docker-compose are also required. If you don't have them installed, you can follow the Docker installation guide and the Docker Compose installation guide.
To install Zammad Gateway you need to follow these steps:
- Clone the repository with:
git clone https://github.com/orienteed/zammad-gateway
- Copy the .env.example file to .env.
- Fill .env file with the required data.
- Run the following command to start the gateway:
docker-compose up -d --build
- Now your gateway is running, you can see an endpoints summary in http://localhost:8081/docs
To contribute to this project, you can do it in the following ways:
- Reporting bugs.
- Suggesting enhancements.
- Opening pull requests.
If you want to know more, please contact us