Skip to main content
Este guia leva você do zero até receber o primeiro evento de webhook.
1

Crie uma chave de API

No ByDoctor, acesse Minha Clínica → API e Webhooks e crie uma nova chave. Escolha Somente leitura para consultar agendamentos e pacientes, ou Acesso total se a integração também vai cadastrar pacientes e criar, alterar ou cancelar agendamentos — o acesso não pode ser alterado depois. Veja Escopos.A chave completa é exibida uma única vez, no formato bd_live_<id>.<secret>. Copie e guarde em um cofre de segredos imediatamente — o ByDoctor armazena apenas o hash e não consegue mostrá-la novamente. Se perdê-la, revogue e crie uma nova.
2

Faça a primeira chamada

Use a chave no cabeçalho Authorization para listar os agendamentos de um período:
A resposta traz uma página de agendamentos e um cursor next para continuar a paginação — veja Agendamentos para o formato completo.
3

Registre um endpoint de webhook

Ainda em Minha Clínica → API e Webhooks, cadastre a URL pública HTTPS que vai receber os eventos e escolha os eventos de interesse (appointment.created, appointment.updated, appointment.cancelled).O segredo de assinatura é exibido uma única vez, no formato whsec_.... Guarde-o do mesmo jeito que a chave de API — ele é necessário para verificar a assinatura de cada evento recebido.
4

Receba o primeiro evento

Use o botão de teste na tela do endpoint para disparar um evento ping e confirmar que seu servidor responde 2xx. A partir daí, qualquer mudança em um agendamento da clínica gera um evento real — veja Webhooks para o envelope completo e a política de reentrega.

Próximos passos

Autenticação

Formato da chave, escopos e limites de uso.

Sincronização

Como manter uma cópia local da agenda em dia.