Pular para o conteúdo principal
WEBHOOK

Autorizações

Authorization
string
header
obrigatório

A chave do app de integração, criada em Integrações. Escopos: patients:read (Listar, buscar e ler pacientes; os eventos patient..); patients:write (Criar e editar pacientes. Inclui ler.); anamneses:read (Listar e ler anamneses, sem as respostas; os eventos anamnesis..); anamneses:write (Enviar, reenviar e cancelar anamnese. Inclui ler.); anamneses:answers (Ler as respostas da anamnese preenchida. É dado de saúde.); documents:read (Atendimentos, documentos, status da assinatura e o PDF; os eventos appointment.* e signature_request.*.); documents:write (Gerar contrato e termos e enviar para assinatura, reenviar e cancelar. Inclui ler.); catalog:read (Procedimentos, prestadores e modelos de documento da clínica.); webhooks:write (Criar, alterar e remover os webhooks do próprio app pela API.)

Cabeçalhos

webhook-id
string
obrigatório

O id do evento.

webhook-timestamp
string
obrigatório

Segundos desde a época.

webhook-signature
string
obrigatório

v1,<base64>; mais de uma, separadas por espaço, na troca do segredo.

Corpo

application/json

Um evento da clínica (RN-INT-15).

id
string
obrigatório

O id do evento; é o webhook-id da entrega.

type
enum<string>
obrigatório

webhook.test só chega no webhook, pelo "Enviar teste"; nunca aparece em GET /v1/events.

Opções disponíveis:
webhook.test,
patient.created,
patient.updated,
patient.archived,
patient.restored,
patient.merged,
anamnesis.sent,
anamnesis.resent,
anamnesis.completed,
anamnesis.canceled,
appointment.documents_generated,
appointment.canceled,
signature_request.sent,
signature_request.resent,
signature_request.viewed,
signature_request.signed,
signature_request.completed,
signature_request.declined,
signature_request.expired,
signature_request.canceled,
signature_request.delivery_failed
createdAt
string
obrigatório

Data e hora ISO 8601, em UTC.

clinicId
string
obrigatório
actor
object
obrigatório
data
object
obrigatório

Os ids do recurso e o essencial; o resto se lê pela API.

Resposta

200

Qualquer 2xx em até 10 segundos é entregue.