API documentation

Connect tickets, contacts and knowledge base to your systems.

Connect tickets, contacts and knowledge base content to your systems with Uppo’s REST APIs. Full documentation is private to workspace members, including Developers invited by an administrator.

  • REST API with JSON responses
  • Workspace keys with configurable permissions
  • Signed inbound webhooks and authenticated outbound calls
api.uppo.io
curl -X POST https://api.uppo.io/api/v2/public/ticket/create \
  -H "Api-Key: YOUR_API_KEY" \
  -H "Api-Secret: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Request created via the API",
    "priority": 3,
    "recipient": {
      "email": "customer@example.com",
      "name": "Jane Doe"
    },
    "message": {
      "body": "Body of the request."
    }
  }'
Example webhook responseticket.updated · HTTP 200

How it works

Authentication, limits and tools

Everything you need to design a clear, maintainable integration.

Authentication

Company API keys with dedicated permissions. Include Api-Key and Api-Secret in the headers of every request.

Rate limits

Handle 429 and Retry-After. Limits vary by endpoint and environment; only retry idempotent writes.

API Playground

Compose a request in the panel, generate a snippet and export it for Postman. Run requests from your own client.

Operations

Core API resources

Work with tickets, contacts and knowledge base through REST APIs, with JSON responses and dedicated access keys for each workspace.

Tickets

POST/ticket/createOpen a ticket
POST/ticket/listList tickets
GET/ticket/detail/{id}Read a ticket
POST/ticket/replyReply to a ticket
POST/ticket/attachment/uploadAttach a file

Contacts

POST/recipient/createCreate a contact
POST/recipient/listList contacts
GET/recipient/detail/{id}Read a contact
POST/recipient/update/{id}Update a contact

Knowledge base

POST/kb/searchSearch the content
POST/kb/content/listList content
GET/kb/content/detail/{id}Read one item
GET/kb/categories/listList categories

Base: https://api.uppo.io/api/v2/public. Full reference in the API documentation.

Webhooks

Incoming and outgoing events

Uppo exchanges events with your systems in both directions.

Incoming webhooks

Receive events at a company-specific endpoint. The signature and secret verify their origin; find both in the panel.

Outgoing requests

Automations call your endpoints with Basic or Bearer authentication. Results and duration stay in the log.

Plan your integration with our team

Tell us which systems you want to connect: we’ll help you design workflows and permissions.