Cfaz Webhook - Agendamentos

Criada por Alexandre Pateis, Modificado em Sex, 19 Dez, 2025 na (o) 11:13 AM por Alexandre Pateis

A Cfaz envia automaticamente os dados completos dos Agendamentos para a URL configurada, para isso basta selecionar o Tipo de Cadastro na configuração do webhook como Agendamento.


A configuração pode ser realizada em:

Configurações → Integração → Webhook


Informações enviadas

  • chave: O Token informado na configuração.
  • event: Tipo do evento que gerou o gatilho de envio do webhook, podendo assumir os seguintes valores:
    • create: Criação
    • update: Atualização
    • delete: Exclusão
  • id: O ID do pedido.
  • patient: Dados do paciente informado no pedido.
  • calendar_id: O ID do calendário ao qual o agendamento está associado.
  • created_by_patient: Um booleano que indica se oi agendamento foi criado pelo próprio paciente, se verdadeiro(true) indica que sim.
  • phone: Telefone informado no agendamento.
  • start: Campo de data/hora que indica o início do agendamento.
  • end: Campo de data/hora que indica o final do agendamento.
  • title: Título do agendamento.
  • description: Descrição do agendamento.
  • comment: Comentário do agendamento.
  • status_text: Status do agendamento.


Estrutura do payload


Exemplo de requisição enviada pelo Cfaz ao webhook do cliente:


{
  "chave": "gun9ns14bkfxqao5bmagw",
  "data": {
    "all_day": false,
    "calendar_id": 158,
    "clinic_id": 19,
    "comment": "Comentário do Agendamento",
    "created_by_patient": false,
    "dentist": null,
    "description": "Descrição do Agendamento",
    "end": "2025-12-17T08:40:00.000-03:00",
    "id": 1158,
    "is_background": false,
    "patient": {
      "birthdate": "2000-01-01",
      "clinic_id": 19,
      "comment": "",
      "commercial_phone": "+55 49 99999 9999",
      "cpf": "00000000000",
      "email": "paciente@paciente.com",
      "father_name": "",
      "father_occupation": "",
      "gender": true,
      "home_phone": "+55 49 99999 9999",
      "id": 476022,
      "mobile_phone": "+55 49 99999 9999",
      "mother_name": "",
      "mother_occupation": "",
      "name": "Paciente Exemplo Agenda",
      "occupation": "",
      "own_cpf": true,
      "race": null,
      "rg_id": "",
      "species": null,
      "spouse_name": "",
      "spouse_phone": "",
      "weight": null
    },
    "phone": "+55 49 99999 9999",
    "start": "2025-12-17T08:10:00.000-03:00",
    "status": 0,
    "status_text": "Aberto",
    "title": "Título do Agendamento",
    "url": "/events/1158"
  },
  "event": "create",
  "timestamp": "2025-12-19T11:08:30-03:00"
}


Validar requisição enviada pelo Cfaz


Para realizar a validação dos dados enviados pelo Cfaz pelo WebHook, leia a documentação:

Validação da Requisição Webhook

Este artigo foi útil?

Que bom!

Obrigado pelo seu feedback

Desculpe! Não conseguimos ajudar você

Obrigado pelo seu feedback

Deixe-nos saber como podemos melhorar este artigo!

Selecione pelo menos um dos motivos
A verificação do CAPTCHA é obrigatória.

Feedback enviado

Agradecemos seu esforço e tentaremos corrigir o artigo