OTOBO Python SDK

Async Python client for the OTOBO GenericInterface REST API — install with pip install otobo.

OTOBO Python SDK

The OTOBO Python SDK is a free, open-source async client for the OTOBO GenericInterface REST API.

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

Who is this for?

Role	Typical use
OTOBO administrators	Automate webservice setup with `otobo-cli setup-system`
Integration developers	Build OTOBO connectors without hand-rolling GenericInterface JSON
OTAI Runtime users	Ticket access from Python plugins on OTOBO systems

Quick start

pip install otobo

from otobo import OTOBOClient, BasicAuth, ClientConfig, TicketOperation

client = OTOBOClient(
    ClientConfig(
        base_url="https://your-otobo-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

Page	Description
Getting started	Install, configure, create a ticket
Webservice setup	Required — configure GenericInterface REST
CLI reference	`otobo-cli setup-system`
API reference	Public exports and client methods
Working with tickets	Search, get, update, errors
Migration	From `otobo_znuny` / `otobo-znuny`
Architecture	OTOBO package layout
Znuny SDK	Sister package for Znuny
Open Ticket AI for OTOBO	Custom AI on your OTOBO queues

Next steps

Follow Webservice setup on your OTOBO host.
Then Getting started in Python.
Explore Open Ticket AI for OTOBO for trained queue models.