ДескусДескус · Документация
Все разделыВебхуки

Как работают вебхуки

Вебхук — POST-запрос от Дескуса на ваш адрес, когда что-то случилось: пришёл тикет, клиент написал, сотрудник ответил, сменился статус, появился клиент. Опрашивать API не нужно — событие придёт за секунды.

События

Событие

Когда

Нужно право

ticket.created

Новый тикет из любого канала

tickets:read

ticket.updated

Сменились статус, приоритет, тема, ответственный, команда, клиент, срок «отложен» или тикет слит

tickets:read

message.created

Новое сообщение: от клиента, ответ сотрудника или заметка

tickets:read

client.created

Новая карточка клиента — из канала, вручную, импортом или через API

clients:read

Право нужно, если подписку создал ключ или приложение. Подписки из настроек получают всё, что отмечено. Формат каждого события — события.

Как подписаться

  • В кабинете: «Настройки → Компания → API и приложения → Вебхуки» → «Добавить вебхук». Укажите адрес и события, сохраните секрет подписи.

  • Через API: POST /webhooks — так подписываются коннекторы, когда клиент собирает связку.

Что должен уметь ваш адрес

  1. Принять POST с JSON по https на порту 443 (http — на 80). Внутренние адреса и другие порты не принимаем, перенаправления не выполняем.

  2. Проверить подпись X-Deskus-Signature.

  3. Отсечь повтор по id события — одно и то же событие может прийти дважды.

  4. Ответить 2xx за 10 секунд. Долгую работу — в свою очередь, после ответа.

Полезно знать

  • Порядок не гарантирован: message.created может прийти раньше ticket.created. Сверяйте created_at и состояние тикета в теле.

  • Событий раньше создания подписки не приходит — историю заберите через API.

  • Не принял — повторим: восемь попыток почти за сутки (повторы и журнал).

  • Проверить адрес можно сразу — кнопка «Проверить адрес» в меню подписки шлёт событие ping.

Не нашли ответ? Напишите нам
Поддержка ответит в рабочее время.
Вы сотрудник «Дескус»?Изменить статью в Дескусе