Webhook do Consultório

Quer que o sistema da sua clínica saiba na hora que uma consulta foi marcada, confirmada ou cancelada, que o paciente chegou à recepção ou que um pagamento entrou? O Webhook do Consultório avisa o seu sistema a cada evento do Consultório: consultas, recepção, pacientes, prontuário, documentos, cobrança, repasse e os cadastros.

O Webhook do Consultório cobre só o Consultório. As conversas com os pacientes são avisadas pelos webhooks da Conexão e do Setor.

Os avisos vão com os dados completos do paciente e da consulta. Aponte o webhook para um sistema da clínica, protegido com o mesmo cuidado do prontuário.

Onde ligar

URL do webhook: o endereço que recebe todos os eventos do Consultório da empresa. Em branco, nada é enviado. Ao salvar, a tela avisa "Webhook salvo."

O endereço precisa começar com https:// e não pode apontar para a rede interna: endereços com http://, localhost ou IPs como 127.0.0.1, 10.0.0.5 e 192.168.0.10 são recusados. Espaços antes e depois do endereço são tirados ao salvar. O seu sistema recebe POST com corpo em JSON.

O campo que separa um aviso do outro

Tudo chega no mesmo endereço, e é o evento que diz o que aconteceu no Consultório. O mesmo nome vem em acao.

Todo aviso do Webhook do Consultório traz também:

id — o código único do evento.

companyId — a empresa.

ocorridoEm — quando o evento aconteceu, com o fuso, como 2026-11-13T11:09:02-03:00.

enviadoEm — quando este envio foi feito, em UTC.

tentativa — 1 no primeiro envio; 2, 3 e assim por diante nas novas tentativas.

autor — quem fez, com tipo (como usuario), id e nome.

origem — de onde veio o evento, como painel (alguém na tela).

backendURL — o endereço do backend da sua instalação.

Exemplo de payload de Repasse

O aviso de um repasse marcado como pago:

{
  "id": "8bb3186f-6fa8-4faf-9cf6-2f4b0775441c",
  "evento": "repasse-pago",
  "acao": "repasse-pago",
  "companyId": 8,
  "repasse": {
    "id": 2,
    "profissionalId": 1,
    "profissional": {
      "id": 1,
      "nome": "Ana Souza"
    },
    "valor": 52,
    "quantidade": 1,
    "observacao": "Pix de novembro",
    "pagoEm": "2026-11-13T14:09:02.384Z",
    "pagoPor": {
      "id": 11,
      "nome": "Carla Recepção"
    },
    "desfeitoEm": null,
    "desfeitoPor": null,
    "consultas": [
      {
        "agendamentoId": 2,
        "repasse": 52,
        "regra": {
          "id": 1,
          "tipo": "percentual",
          "valor": 40,
          "origem": "profissional"
        }
      }
    ]
  },
  "ocorridoEm": "2026-11-13T11:09:02-03:00",
  "autor": {
    "tipo": "usuario",
    "id": 11,
    "nome": "Carla Recepção"
  },
  "origem": "painel",
  "backendURL": "https://backend_url.com.br",
  "tentativa": 1,
  "enviadoEm": "2026-11-13T14:09:02.410Z"
}

O que cada aviso traz a mais

Sala (sala-criada, sala-alterada e sala-removida): sala, com id, nome, descricao e ativo. A sala removida também chega completa.

Regra de repasse (regra-de-repasse-salva e regra-de-repasse-removida): regra, com o profissional e o servico (null quando a regra vale para Todos), o tipo (percentual ou fixo), o valor e a origem (profissional, servico ou par). Na regra nova, nova vem true.

Repasse (repasse-pago e repasse-desfeito): repasse, com o profissional, o valor, a quantidade de consultas, a observacao, quem pagou e quando (pagoPor e pagoEm), quem desfez e quando (desfeitoPor e desfeitoEm) e as consultas, cada uma com o agendamentoId e o repasse. No pago, cada consulta traz também a regra que valeu.

Pagamento (pagamento-registrado e pagamento-estornado): o agendamentoId, o pagamento (forma, valor, situação e as horas da confirmação e do estorno) e a cobranca da consulta como ficou — valor, pago, falta, situacao e a lista de pagamentos. O estorno traz também devolvidoNoProvedor, que vem false no pagamento registrado à mão.

Consulta paga (consulta-paga): o agendamentoId e a cobranca quitada. Chega junto com o pagamento-registrado do pagamento que completou o valor.

Entrega e novas tentativas

O aviso conta como entregue quando o seu sistema responde 2xx em até 15 segundos. Se não, o evento é enviado de novo depois de 1 min, 5 min, 30 min, 2 h, 6 h e 24 h, em sete tentativas ao todo. Depois da última, os administradores da empresa são avisados no sino.

Na nova tentativa, o ocorridoEm continua o de quando o evento aconteceu; o enviadoEm e a tentativa são os do novo envio.

Um evento que precisou de nova tentativa chega depois dos eventos que vieram a seguir. Para saber a ordem em que as coisas aconteceram, use o ocorridoEm, não a ordem de chegada, e use o id para reconhecer um evento que você já recebeu.

Como saber que o aviso veio daqui

Todo aviso vai assinado com o Token da Empresa, e o token não vai no corpo do aviso. Os cabeçalhos: