Webhooks

Já tens uma chave? Personaliza os exemplos temporariamente

Opcional. A chave ficará visível nos exemplos de código. Fica apenas na memória desta página: sem guardar nem enviar. Limpa-a antes de partilhar o ecrã ou capturas.

Os exemplos usam valores ilustrativos. Para enviar, cria uma conta e uma chave API e aguarda a aprovação do Sender ID.

$ Gerar Chave

Developers / Eventos

Webhooks de produção

Entrega eventos para URLs HTTPS públicas com certificado TLS válido. Endereços privados, locais e reservados são bloqueados, incluindo IPv6; todos os resultados DNS devem ser públicos. Não seguimos redirecionamentos. Responde com HTTP 2xx em até 8 segundos e processa o evento de forma assíncrona. Cada pedido inclui identificador, tipo, data e dados sem conteúdo sensível. Há até seis tentativas automáticas, incluindo a primeira. O consumidor deve deduplicar o id do evento; recuperação após falha pode repetir uma entrega. Retry manual recusa entregas em curso ou já entregues. A ordem de entrega não é garantida: deduplica pelo id do evento e consulta o estado da mensagem quando necessário.

POST/webhook-endpoints

Cria um endpoint. O segredo whsec_ é devolvido apenas nesta resposta.

namestringobrigatório

Nome interno do endpoint

urlstringobrigatório

URL HTTPS pública

eventsstring[]opcional

Tipos desejados; omite para receber todos

curl -X POST https://api.kambasms.ao/webhook-endpoints \
  -H "X-API-Key: SUA_API_KEY" -H "Content-Type: application/json" \
  -d '{"name":"Produção","url":"https://api.exemplo.ao/webhooks/kambasms","events":["verify.completed","message.status"]}'

Assinatura: HMAC SHA-256 de timestamp.raw_body. Lê x-kambasms-timestamp e compara x-kambasms-signature em tempo constante. Rejeita pedidos com mais de cinco minutos.
Eventos: message.status, verify.started, verify.completed, verify.failed, link.clicked, chat.conversation.created, chat.message.created, notify.sent e email.sent/delivered/bounced/complained/opened/clicked/failed.

Gestão: GET /webhook-endpoints, PATCH/DELETE /webhook-endpoints/:id, POST /webhook-endpoints/:id/test, GET /webhook-deliveries e POST /webhook-deliveries/:id/retry.