Вебхуки и оповещения
Вебхуки доставляют push-уведомления, когда меняется статус отслеживаемого рейса. События берутся из того же live-потока статусов рейсов, что и Статус рейса, — ваш сервер получает HTTP-колбэки POST вместо того, чтобы опрашивать API.
Требования
x-api-key в каждом запросе (прямая подписка). Подробнее →Pro, Ultra или Mega — на тарифе BASIC создавать вебхуки нельзя
Подробнее →| Тариф | Макс. число активных вебхуков |
|---|---|
| BASIC | 0 (создание отклоняется) |
| PRO | 1 |
| ULTRA | 3 |
| MEGA | 10 |
Статус опрашивается каждые 5 минут. Подписки автоматически отключаются после 10 неудачных доставок подряд. Подробнее о тарифах: Ограничения частоты запросов.
| Эндпоинт | Страница | Когда использовать |
|---|---|---|
POST /webhooks | Подписки | Зарегистрировать URL колбэка для рейса |
GET /webhooks | Подписки | Получить список подписок для вашего API-ключа |
PATCH /webhooks/{webhook_id} | Подписки | Приостановить или возобновить без удаления |
DELETE /webhooks/{webhook_id} | Подписки | Безвозвратно удалить подписку |
GET /webhooks/events | Типы событий | Узнать поддерживаемые значения event_types |
| (входящий) | Доставка колбэков | Тело HTTP-запроса POST, которое получает ваш сервер |
Вебхуки или опрос. Для оповещений о смене гейта вебхуков с интервалом опроса 5 минут обычно достаточно, и это намного дешевле, чем опрашивать Статус рейса чаще раза в минуту. Используйте опрос, когда нужны запросы по требованию без зарегистрированного URL колбэка.
Ответы с ошибками
Общие ошибки платформы: Обработка ошибок. Ограничение по тарифу:
403 — тариф не включает вебхуки
{
"detail": "Webhook subscriptions require PRO, ULTRA, or MEGA plan (current plan: BASIC)."
}Ошибки, специфичные для эндпоинтов (404 при проверке владельца, доставка колбэков), описаны на страницах Подписки и Доставка колбэков.
См. также: Статус рейса · Ограничения частоты запросов