Ендпоінти вебхуків

Адреси, на які ми надсилаємо події цього закладу.

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 }