Referência da API

Webhooks

Crie assinaturas para receber eventos relevantes da plataforma no seu backend.

#Endpoints

MétodoCaminhoDescrição
POST/v1/webhooksCria assinatura e retorna secret.
POST/v1/webhooks/:id/rotate-secretRotaciona secret com janela de graça.
POST/v1/webhooks/:id/enableHabilita a assinatura.
POST/v1/webhooks/:id/disableDesabilita a assinatura.
POST/v1/webhooks/:idAtualiza URL e/ou eventos.
DELETE/v1/webhooks/:idRemove a assinatura.
GET/v1/webhooks/:idLê metadados da assinatura.
GET/v1/webhooksLista assinaturas por cursor.

#Criar assinatura

json
{
  "url": "https://api.example.com/noorden/webhooks",
  "events": ["agent.message", "session.status_idle"]
}

A criação retorna o secret uma única vez. Armazene-o no seu backend para validar entregas.

#Rotacionar secret

json
{
  "gracePeriodSeconds": 86400
}

Durante a janela de graça, o consumidor pode aceitar assinaturas do secret antigo e do novo enquanto o deploy propaga.