Configurer un SDK

Webhooks propose des SDK officiels pour Python, TypeScript et Go, tous en version 0.7.0. Ils réessaient en cas d’échec temporaire, vérifient les signatures des webhooks et peuvent mettre les événements en tampon tant que l’API est injoignable. Choisissez un langage en haut de la page : tous les exemples le suivent.

Inboxes et QR Codes n’ont pas encore de SDK ; appelez-les en REST. La référence de l’API montre chacun de leurs appels avec le client HTTP habituel de votre langage. Les SDK pour l’infrastructure (VM, stockage, bases de données) ne sont pas encore disponibles non plus.

1 · Installer

pip install nn-webhooks-sdk

Python nécessite la version 3.11 ou ultérieure, TypeScript Node.js 24 ou ultérieur, et Go la version 1.25 ou ultérieure. Le paquet Python s’installe sous le nom nn-webhooks-sdk et s’importe sous le nom nn_webhooks.

2 · S’authentifier

Créez une clé Webhooks dans votre console de compte, sous API keys : Obtenir une clé API donne les détails. Créez ensuite un client à partir de cette clé. Lisez la clé depuis l’environnement plutôt que de l’écrire dans votre code.

import os
from nn_webhooks import Client

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

3 · Faire un premier appel

Listez vos livraisons récentes. Cet appel ne fait que lire : n’importe quelle clé admin ou read peut donc l’exécuter.

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

Une liste vide signifie que la clé fonctionne et que rien n’a encore été livré. Pour publier votre premier événement, suivez le démarrage rapide Webhooks.

Étapes suivantes

• SDK Webhooks : la vérification des signatures, la publication, l’outbox durable (file d’envoi locale), la gestion des endpoints.
• Référence de l’API Webhooks : toutes les opérations, avec l’appel SDK quand le SDK en propose un.
• CLI : les mêmes opérations depuis un shell.