RECURSO DE API

Webhooks

À medida que os eventos ocorrem na sua clínica, uma notificação assinada é enviada ao endereço registrado; assim você mantém o seu próprio sistema atualizado em tempo real.

Acesso Antecipado Toda a API

Endpoints

3 endpoint

Endpoints deste recurso. Cada endpoint é limitado aos dados da clínica à qual a chave de API está vinculada; os endpoints de gravação suportam o cabeçalho Idempotency-Key.

GET /v1/webhooks Lista as assinaturas de webhook registradas admin

POST /v1/webhooks Registra um webhook para notificação de eventos admin

DELETE /v1/webhooks/{id} Exclui a assinatura de webhook admin

Exemplo de Uso

Registrar webhook

Requisição

curl -X POST https://api.udentiva.com/v1/webhooks \
  -H "Authorization: Bearer udk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://siz.example/hook","events":["payment.created"]}'

Resposta

HTTP/1.1 201 Created
{
  "id": "wh-1",
  "url": "https://siz.example/hook",
  "events": ["payment.created"],
  "secret": "whsec_xxx"
}

Segurança neste recurso

Segurança não é um recurso, é a própria arquitetura. As garantias que se aplicam a este recurso:

Cada notificação é assinada com a chave secreta compartilhada (HMAC); ao verificar a assinatura, você confirma que a requisição veio realmente da UDENTIVA.

Reenvio seguro: cada evento tem um identificador único; você pode filtrar entregas duplicadas pelo identificador (consumo idempotente).

As assinaturas de webhook são isoladas à sua clínica; você recebe apenas os seus próprios eventos.

Todo o modelo de segurança →

Formato de Erro

Os erros retornam em um envelope consistente; o código é destinado à máquina, a mensagem ao usuário. Erro interno/stack nunca é vazado.

{
  "error": {
    "code": "validation_failed",
    "message": "Campo inválido: e-mail"
  }
}

Outros Recursos

Pacientes Agendamentos e calendário Odontograma & Tratamento Cobrança e Finanças Estoque Imagem Laboratório Lead & CRM Turismo de saúde Relatórios & BI Transferência de Dados (Export API)

Deseja acesso antecipado?

Seja o primeiro a saber quando a API for lançada.

Entre em Contato