Ler evento - Westhetics · Desenvolvedores

GET

/

v1

/

events

/

{id}

Ler evento

curl --request GET \
  --url https://api.westhetics.io/v1/events/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.westhetics.io/v1/events/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "id": "0e9d8c7b-6a5f-4e3d-9c2b-1a0f9e8d7c6b",
    "type": "signature_request.completed",
    "createdAt": "2026-10-15T14:30:00Z",
    "clinicId": "2b7f0a3c-5d1e-4c8a-9f60-1a2b3c4d5e6f",
    "actor": {
      "type": "system",
      "id": null
    },
    "data": {
      "signatureRequestId": "6f7e8d9c-0b1a-4f2e-9d3c-4b5a69788796",
      "appointmentId": "3c9d1e2f-4a5b-4c7d-8e9f-0a1b2c3d4e5f",
      "patientId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "protocolNumber": "WX-4472-BM",
      "documentIds": [
        "d4e5f6a7-b8c9-4123-8ef4-567890123456"
      ]
    }
  }
}

{
  "error": {
    "code": "bad_request",
    "message": "<string>",
    "requestId": "<string>",
    "fields": {}
  }
}

{
  "error": {
    "code": "bad_request",
    "message": "<string>",
    "requestId": "<string>",
    "fields": {}
  }
}

{
  "error": {
    "code": "bad_request",
    "message": "<string>",
    "requestId": "<string>",
    "fields": {}
  }
}

{
  "error": {
    "code": "bad_request",
    "message": "<string>",
    "requestId": "<string>",
    "fields": {}
  }
}

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.)

Parâmetros de caminho

id

string<uuid>

obrigatório

Resposta

Sucesso.

data

object

obrigatório

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

Show child attributes

Ler evento

curl --request GET \
  --url https://api.westhetics.io/v1/events/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.westhetics.io/v1/events/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "id": "0e9d8c7b-6a5f-4e3d-9c2b-1a0f9e8d7c6b",
    "type": "signature_request.completed",
    "createdAt": "2026-10-15T14:30:00Z",
    "clinicId": "2b7f0a3c-5d1e-4c8a-9f60-1a2b3c4d5e6f",
    "actor": {
      "type": "system",
      "id": null
    },
    "data": {
      "signatureRequestId": "6f7e8d9c-0b1a-4f2e-9d3c-4b5a69788796",
      "appointmentId": "3c9d1e2f-4a5b-4c7d-8e9f-0a1b2c3d4e5f",
      "patientId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "protocolNumber": "WX-4472-BM",
      "documentIds": [
        "d4e5f6a7-b8c9-4123-8ef4-567890123456"
      ]
    }
  }
}

{
  "error": {
    "code": "bad_request",
    "message": "<string>",
    "requestId": "<string>",
    "fields": {}
  }
}

{
  "error": {
    "code": "bad_request",
    "message": "<string>",
    "requestId": "<string>",
    "fields": {}
  }
}

{
  "error": {
    "code": "bad_request",
    "message": "<string>",
    "requestId": "<string>",
    "fields": {}
  }
}

{
  "error": {
    "code": "bad_request",
    "message": "<string>",
    "requestId": "<string>",
    "fields": {}
  }
}