Znuny Python SDK

Async Python client for the Znuny GenericInterface REST API — install with pip install znuny.

Znuny Python SDK

The Znuny Python SDK is a free, open-source async client for the Znuny GenericInterface REST API. Use it from scripts, connectors, or automation pipelines — no OTOBO package required.

• License: MIT
• Package: znuny on PyPI
• Source: github.com/Softoft-Orga/otobo-znuny-python-client

What is Znuny?

Znuny is an open-source helpdesk and IT service management system. It grew out of the OTRS codebase and still uses the same GenericInterface REST API for external integrations. If you administer Znuny but have never used OTOBO, that is fine — this documentation is written for Znuny only.

Do I need OTOBO?

No. Install znuny from PyPI and import ZnunyClient. You do not need the otobo package, OTOBO documentation, or an OTOBO server. The two PyPI packages share internal code, but each targets its own product.

Who is this for?

GenericInterface in brief

Znuny exposes ticket operations through webservices in the admin area. Each webservice defines named operations (for example TicketCreate, TicketGet) that map to URL paths under:

/Webservice/{WebserviceName}/{OperationName}

The Python SDK wraps those calls with typed models (TicketCreate, TicketSearch, …) so you work with Python objects instead of raw JSON.

Quick start

pip install znuny

from znuny import ZnunyClient, BasicAuth, ClientConfig, TicketOperation

client = ZnunyClient(
    ClientConfig(
        base_url="https://your-znuny-server",
        webservice_name="MyWebservice",
        operation_url_map={
            TicketOperation.CREATE: "ticket-create",
            TicketOperation.GET: "ticket-get",
            TicketOperation.SEARCH: "ticket-search",
            TicketOperation.UPDATE: "ticket-update",
        },
    )
)
client.login(BasicAuth(user_login="agent", password="secret"))

Documentation map

Next steps

1. Follow Webservice setup on your Znuny server.
2. Then Getting started in Python.
3. Explore Open Ticket AI for Znuny for trained queue models.