☰ Меню · Адреса вебхуков
Справочник API

Адреса вебхуков

Куда мы отправляем события этого заведения.

POST/v1/webhook_endpoints
Право: webhooks:write

Добавляет адрес. url должен быть публичным и работать по HTTPS. events это список типов событий; если его не передать, будут приходить все. secret для проверки подписи есть только в этом ответе.

curl
curl https://loyaltyfy.io/api/v1/webhook_endpoints \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://pos.example.com/loyaltyfy/webhooks",
    "events": ["transaction.completed", "order.created"]
  }'
Ответ · 201
{
  "object": "webhook_endpoint",
  "id": "01c2a784-4bcf-43b9-8ac9-ddbad7a25341",
  "url": "https://pos.example.com/loyaltyfy/webhooks",
  "description": null,
  "events": ["transaction.completed", "order.created"],
  "status": "enabled",
  "disabled_reason": null,
  "livemode": false,
  "created_at": "2026-10-06T18:17:32.381+00:00",
  "secret": "whsec_UvjHvXfPk80ITYl_xPeAtskI0WjR8-PS"
}
GET/v1/webhook_endpoints
Право: webhooks:write

Все адреса заведения.

GET/v1/webhook_endpoints/{id}
Право: webhooks:write

Один адрес, с его статусом и причиной отключения, если он отключён.

PATCH/v1/webhook_endpoints/{id}
Право: webhooks:write

Меняет url, events, description или enabled. С помощью enabled: true можно снова включить адрес, отключённый из-за сбоев.

DELETE/v1/webhook_endpoints/{id}
Право: webhooks:write

Удаляет адрес. Текущие доставки прекращаются.

POST/v1/webhook_endpoints/{id}/test
Право: webhooks:write

Сразу отправляет подписанное событие test.ping и показывает, что ответил ваш адрес.

curl
curl -X POST https://loyaltyfy.io/api/v1/webhook_endpoints/01c2a784-4bcf-43b9-8ac9-ddbad7a25341/test \
  -H "Authorization: Bearer sk_test_..."

# { "object": "webhook_test", "delivered": true, "status_code": 200, "error": null }
Вопросы по интеграции: api@loyaltyfy.io. Отвечаем в течение одного рабочего дня.