For Developers
SupportHub REST API
The complete guide to the public REST API: tickets, messages, contacts, long polling and webhooks, with examples in cURL, Python and Node.js.
In this section:
Introduction
When to use REST, the widget, webhooks or polling.
Authentication
API keys: creating, sending and disabling them.
Limits & errors
Rate limits, error codes, retry strategy.
Tickets
Create, update, close and reopen tickets; filters and pagination.
Ticket history
All of a contact's tickets with a last-message preview.
Ticket rating
Rate a ticket from 1 to 5 through the API.
Messages
Reading, sending and editing messages; inbound messages from external systems.
Media
Uploading and downloading files, attachments.
Contacts
Searching, reading and creating contacts; extra_data.
Updates (long polling)
GET /updates, like Telegram's getUpdates.
Webhooks
Event subscriptions, signatures, retries.
Widget
Embedding: attributes, JS API, language, visitor session.
Python SDK
The official Python client: installation and examples.
Examples
Ready-made scenarios in Python and Node.
Was this page helpful?