Ezx DeskДокументация v4.12.2
Документация › Разработчикам › REST API

REST API

REST API открывает те же действия, что и интерфейс: заявки, клиенты, комментарии, метки. Ответы — JSON, кодировка UTF-8.

Ключ доступа

Ключ создаётся в Профиль → Ключи API и наследует права своего владельца. Передаётся в заголовке:

Authorization: Bearer ezx_live_7Hq...

Для интеграций заведите отдельного сотрудника с ролью «Оператор» — так в журнале будет видно, что действие выполнила система, а не человек.

Заявки

МетодПутьЧто делает
GET/api/v2/ticketsСписок с фильтрами status, queue, updated_since
POST/api/v2/ticketsСоздать заявку
GET/api/v2/tickets/{id}Заявка с последними 50 сообщениями
PATCH/api/v2/tickets/{id}Изменить статус, приоритет, исполнителя, метки
POST/api/v2/tickets/{id}/commentsОтвет клиенту или внутренняя заметка
curl -s https://desk.example.com/api/v2/tickets \
  -H "Authorization: Bearer $EZX_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
        "subject": "Не приходят письма о заказе",
        "requester": {"email": "ivanova@example.com", "name": "Анна Иванова"},
        "queue": "first-line",
        "priority": "normal",
        "body": "С понедельника не получаем подтверждения заказов."
      }'
{
  "id": 48213,
  "number": "#48213",
  "status": "new",
  "queue": "first-line",
  "sla": {"first_response_due": "2026-10-09T15:40:00+03:00"},
  "created_at": "2026-10-09T07:40:12+03:00"
}

Постраничный вывод

Списки отдаются по 50 записей. Следующую страницу запрашивают по значению next_cursor из ответа. Поле пустое — записей больше нет.

Вебхуки

Вебхук отправляет POST-запрос на ваш адрес при событиях ticket.created, ticket.updated, comment.created. Подпись запроса — в заголовке X-Ezx-Signature (HMAC-SHA256 тела по секрету вебхука). Если ваш сервер не ответил кодом 2xx, доставка повторяется 6 раз с растущей паузой до 2 часов.

Ограничения

600 запросов в минуту на ключ. При превышении сервер отвечает 429 и заголовком Retry-After.

Обновлено 9 октября 2026 · относится к версии 4.12