Início rápido

Você vai precisar da chave de um app da clínica (wx_…) e de um endereço https:// público para receber o webhook. Os exemplos usam a variável WESTHETICS_API_KEY.

export WESTHETICS_API_KEY="wx_…"

A chave dá acesso aos dados da clínica nos escopos do app. Guarde num cofre de segredos ou numa variável de ambiente do servidor. Nunca no navegador, no aplicativo do celular nem no repositório.

Crie o app no painel

Quem faz é a gestora da clínica (ou a equipe da Westhetics, dentro da clínica):

Em app.westhetics.io, abra Integrações e toque em + Novo app.
Dê um nome (“CRM da recepção”) e marque as permissões. Para este guia: Pacientes · Ler e escrever e Gerenciar os próprios webhooks pela API.
Toque em Criar app e copie a chave. Ela não aparece de novo; se perder, regenere.

Confirme a chave

GET /v1/me diz qual app está chamando, em que clínica e com quais escopos.

curl https://api.westhetics.io/v1/me \
  -H "Authorization: Bearer $WESTHETICS_API_KEY"

const res = await fetch('https://api.westhetics.io/v1/me', {
  headers: { Authorization: `Bearer ${process.env.WESTHETICS_API_KEY}` },
})
const { data } = await res.json()
console.log(data.clinic.name, data.integration.scopes)

import os, requests

res = requests.get(
    "https://api.westhetics.io/v1/me",
    headers={"Authorization": f"Bearer {os.environ['WESTHETICS_API_KEY']}"},
    timeout=10,
)
print(res.json()["data"]["clinic"]["name"])

Resposta

{
  "data": {
    "type": "integration",
    "integration": {
      "id": "6f1d2c3b-8a4e-4f7a-9c1d-2b3e4f5a6b7c",
      "name": "CRM da recepção",
      "description": null,
      "scopes": ["patients:write", "webhooks:write"],
      "keyPrefix": "1c0a58f5",
      "createdAt": "2026-10-15T14:20:00Z"
    },
    "user": null,
    "role": null,
    "clinic": {
      "id": "0b9a8c7d-6e5f-4a3b-2c1d-0e9f8a7b6c5d",
      "name": "Clínica Aurora",
      "legalName": "Aurora Estética Avançada Ltda",
      "timezone": "America/Sao_Paulo"
    }
  }
}

Um 401 quer dizer que a chave não confere ou foi revogada. Veja erros.

Cadastre um webhook

O webhook recebe os eventos da clínica que o app pode ver. A resposta traz o segredo, que assina cada entrega: guarde junto com a chave.

curl https://api.westhetics.io/v1/webhooks \
  -H "Authorization: Bearer $WESTHETICS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://crm.exemplo.com.br/webhooks/westhetics",
    "description": "CRM: fichas novas",
    "events": ["patient.created", "patient.updated"]
  }'

A gestora também pode cadastrar o webhook pela tela do app, em Integrações. Os detalhes estão em webhooks pela API.

Crie uma paciente

Nome, WhatsApp e e-mail são obrigatórios, e quem tem menos de 18 anos vem com o responsável legal; o resto adianta o atendimento e o contrato.

curl https://api.westhetics.io/v1/patients \
  -H "Authorization: Bearer $WESTHETICS_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "name": "Amanda Ribeiro Costa",
    "whatsapp": "11987654321",
    "email": "amanda@email.com",
    "birthDate": "1994-03-12",
    "docNumber": "39053344705"
  }'

A resposta é 201 com a ficha inteira. Em seguida o webhook recebe patient.created:

{
  "id": "3a2b1c0d-9e8f-4a7b-8c6d-5e4f3a2b1c0d",
  "type": "patient.created",
  "createdAt": "2026-10-15T14:31:07Z",
  "clinicId": "0b9a8c7d-6e5f-4a3b-2c1d-0e9f8a7b6c5d",
  "actor": { "type": "integration", "id": "6f1d2c3b-8a4e-4f7a-9c1d-2b3e4f5a6b7c" },
  "data": { "patientId": "f47ac10b-58cc-4372-a567-0e02b2c3d479" }
}

Antes de confiar no corpo, confira a assinatura: verificar a assinatura.

Próximos passos

Do CRM ao contrato assinado

O fluxo inteiro: paciente, anamnese, contrato, assinatura e o PDF assinado.

Referência da API

Todas as rotas, com os campos, os erros e o teste direto na página.

Começar

Guias

Como a API funciona

Próximos passos

Do CRM ao contrato assinado

Referência da API