Тестовая отправка

POST/api/v1/vpn/webhook/test

Шлёт событие webhook.test на ваш адрес прямо сейчас и возвращает, что ответил сервер. Одна попытка, без ретраев.

curl -X POST https://api.relayhub.surf/api/v1/vpn/webhook/test \
  -H "Authorization: Bearer <YOUR_API_KEY>"
Вставьте свой ключ в меню, и он подставится вместо <YOUR_API_KEY>.
{
  "success": true,
  "delivered": true,
  "status": "delivered",
  "http_status": 200,
  "duration_ms": 143,
  "delivery_id": "01a06321-0000-7000-8000-000000000001"
}

Авторизация

Заголовок Authorization: Bearer <ключ> на каждом запросе. Ключ один на аккаунт, выпускается в кабинете партнёра и показывается один раз. Он тратит депозит: держите его на сервере.

Поля ответа

successbooleanобязательно
deliveredbooleanобязательно
statusstringобязательно
http_statusintegerобязательно
duration_msintegerобязательно
delivery_idstringобязательно

Когда откажет

401unauthorized: Неверный или отсутствующий API-ключ
403api_disabled: Доступ к API для этого аккаунта закрыт
409webhook_not_configured: Адрес вебхука не задан
429rate_limited: Слишком много запросов
503upstream_unavailable: Поставщик VPN временно недоступен
Собираем анонимную аналитику посещений. Подробнее