Configurar um SDK

O Webhooks tem SDKs oficiais para Python, TypeScript e Go, todos na versão 0.7.0. Eles repetem as tentativas em falhas transitórias, verificam assinaturas de webhooks e podem armazenar eventos em buffer enquanto a API está inacessível. Escolha uma linguagem no topo da página e todos os exemplos a acompanham.

Inboxes e Códigos QR ainda não têm SDK; chame-os via REST. A referência da API mostra cada uma das chamadas deles com o cliente HTTP habitual da sua linguagem. Os SDKs para Infraestrutura (VMs, armazenamento, bancos de dados) também ainda não estão disponíveis.

1 · Instalar

pip install nn-webhooks-sdk

O Python exige a versão 3.11 ou posterior, o TypeScript exige Node.js 24 ou posterior e o Go exige a versão 1.25 ou posterior. O pacote Python é instalado como nn-webhooks-sdk e importado como nn_webhooks.

2 · Autenticar

Crie uma chave de Webhooks no console da sua conta, em API keys: os detalhes estão em Obter uma chave de API. Depois, crie um cliente com ela. Leia a chave do ambiente em vez de escrevê-la no seu código.

import os
from nn_webhooks import Client

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

3 · Fazer a primeira chamada

Liste suas entregas recentes. A chamada só lê dados, então qualquer chave admin ou read pode executá-la.

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

Uma lista vazia significa que a chave funciona e que nada foi entregue ainda. Para publicar seu primeiro evento, siga o início rápido de Webhooks.

Próximos passos

• SDKs de Webhooks: verificação de assinaturas, publicação, o outbox durável, gerenciamento de endpoints.
• Referência da API de Webhooks: todas as operações, com a chamada do SDK quando o SDK tiver uma.
• CLI: as mesmas operações a partir de um shell.