Налаштування SDK

У Webhooks є офіційні SDK для Python, TypeScript і Go, усі версії 0.7.0. Вони повторюють запити після тимчасових збоїв, перевіряють підписи вебхуків і можуть буферизувати події, поки API недоступний. Виберіть мову вгорі сторінки, і всі приклади перемкнуться на неї.

Для Inboxes і QR-кодів SDK поки немає; викликайте їх через REST. Довідник API показує кожен їхній виклик через звичайний HTTP-клієнт вашої мови. SDK для інфраструктури (VM, сховище, бази даних) теж поки немає.

1 · Встановлення

pip install nn-webhooks-sdk

No REST example here; showing Python.

Для Python потрібна версія 3.11 або новіша, для TypeScript — Node.js 24 або новіший, для Go — 1.25 або новіша. Пакет для Python встановлюється як nn-webhooks-sdk, а імпортується як nn_webhooks.

2 · Налаштуйте автентифікацію

Створіть ключ Webhooks у консолі акаунта в розділі API keys: подробиці — у розділі Отримайте API-ключ. Потім створіть із ним клієнт. Читайте ключ зі змінної середовища, а не записуйте його в код.

import os
from nn_webhooks import Client

wh = Client("https://webhooks.nimbusnexus.net", api_key=os.environ["WEBHOOKS_API_KEY"])

No REST example here; showing Python.

3 · Перший виклик

Отримайте список останніх доставок. Цей виклик лише читає дані, тож його може виконати будь-який ключ admin або read.

page = wh.list_deliveries()
for d in page["items"]:
    print(d["id"], d["status"], d["attempts"])

No REST example here; showing Python.

Порожній список означає, що ключ працює, а доставок ще не було. Щоб опублікувати першу подію, пройдіть Швидкий старт Webhooks.

Що далі

SDK Webhooks: перевірка підписів, публікація, надійний outbox, керування ендпоінтами.
Довідник API Webhooks: усі операції з викликом SDK, якщо SDK його має.
CLI: ті самі операції з командного рядка.