GET и POST /webhooks — подписки

Через API подписываются коннекторы: клиент собирает связку «новый тикет → сделка в CRM», и коннектор сам создаёт подписку на свой адрес. Право — webhooks.

Создать

Запрос

curl https://app.deskus.ru/api/v1/webhooks \
  -H "Authorization: Bearer $DESKUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://crm.example.com/deskus/webhook",
    "events": ["ticket.created", "message.created"],
    "description": "CRM обжарки"
  }'

Ответ 201

{
  "data": {
    "id": "c8a1f5e3-2d9b-4c6a-8e0f-7b3d1a9c5e26",
    "url": "https://crm.example.com/deskus/webhook",
    "description": "CRM обжарки",
    "events": ["ticket.created", "message.created"],
    "enabled": true,
    "disabled_reason": null,
    "source": "api_key",
    "last_success_at": null,
    "last_failure_at": null,
    "failing_since": null,
    "created_at": "2026-10-21T09:20:11.507Z",
    "secret": "whsec_Hn3…"
  }
}

secret — ключ подписи событий (проверка подписи). Целиком приходит только здесь — сохраните его.

Список

curl https://app.deskus.ru/api/v1/webhooks \
  -H "Authorization: Bearer $DESKUS_KEY"

Ответ — { "data": [ … ] } без страниц. Ключ и приложение видят только свои подписки; подписки из настроек и других ключей им не видны. Один — GET /webhooks/{id}.

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

• Событий раньше создания подписки она не получает.

• Подписка получает только события, на которые у ключа есть право чтения (права).

• Отзыв ключа или отключение приложения удаляет его подписки.

• У компании до 25 подписок — иначе 409 conflict. Адрес не подходит — 422.

• Подписки, созданные через API, видны администратору в настройках с пометкой «Создана ключом API» или «Создана приложением».