Skip to main content
POST
https://loveandpay.io
/
api
/
v1
/
webhooks
Создание вебхука
curl --request POST \
  --url https://loveandpay.io/api/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "url": "<string>",
  "events": [
    {}
  ],
  "secret": "<string>"
}
'
{
  "id": "<string>",
  "url": "<string>",
  "events": [
    {}
  ],
  "secret": "<string>",
  "active": true,
  "createdAt": "<string>"
}

​
Создание вебхука

Регистрирует URL-адрес для получения уведомлений о событиях в вашем аккаунте.

​
Аутентификация

​
x-api-key
string
required
Ваш API ключ

​
Параметры запроса

​
url
string
required
URL для отправки уведомлений. Должен быть HTTPS.
​
events
array
required
Массив событий для подписки. Доступные события:
  • invoice.created - счёт создан
  • invoice.paid - счёт оплачен
  • invoice.expired - счёт истёк
  • invoice.cancelled - счёт отменён
  • kyc.completed - KYC верификация завершена
  • kyc.failed - KYC верификация не пройдена
​
secret
string
Секретный ключ для подписи вебхуков. Если не указан, будет сгенерирован автоматически.

​
Пример запроса

curl -X POST "https://loveandpay.io/api/v1/webhooks" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://yoursite.com/webhooks/loveandpay",
    "events": ["invoice.paid", "invoice.expired"]
  }'

​
Пример ответа

​
id
string
Уникальный идентификатор вебхука
​
url
string
URL для уведомлений
​
events
array
Список событий для подписки
​
secret
string
Секретный ключ для верификации подписи. Показывается только один раз!
​
active
boolean
Статус активности вебхука
​
createdAt
string
Дата создания
Успешный ответ (201)
{
  "id": "wh_abc123def456",
  "url": "https://yoursite.com/webhooks/loveandpay",
  "events": ["invoice.paid", "invoice.expired"],
  "secret": "whsec_a1b2c3d4e5f6g7h8i9j0...",
  "active": true,
  "createdAt": "2024-01-15T10:30:00Z"
}
Секретный ключ (secret) показывается только при создании вебхука. Обязательно сохраните его в безопасном месте для верификации входящих уведомлений.

​
Управление вебхуками

После создания вы можете управлять вебхуками через панель управления или API:
  • GET /webhooks - список всех вебхуков
  • GET /webhooks/ - получить вебхук по ID
  • PATCH /webhooks/ - обновить вебхук
  • DELETE /webhooks/ - удалить вебхук

​
Ошибки

КодОписание
400Неверные параметры (URL не HTTPS, неизвестные события)
401Неверный API ключ
409Вебхук с таким URL уже существует
422Валидация не пройдена