Skip to main content

POST Criar Endpoint de Webhook

Cadastra um endpoint de webhook na conta. O secret de assinatura é devolvido uma única vez, nesta resposta.

Autenticação necessária

Envie o header Authorization: Bearer {accessToken} (token de usuário) ou x-api-key: {apiKey} (integrações). Veja Autenticação.

Permissão necessária

Exige a permissão manage_webhooks.

Guarde o secret

O secret não é devolvido de novo na listagem nem na edição. Se for perdido, gere outro com Rotacionar Segredo.


Endpoint​

POST https://api-dev.imagemais.com.br/api/webhooks/endpoints

Corpo da Requisição​

CampoTipoObrigatórioValores válidosDescrição
urlstring✅URL http/https com protocolo; até 2048 caracteresURL que vai receber os eventos. Em produção só https; hosts de rede interna são rejeitados
descriptionstring❌até 255 caracteresDescrição livre do endpoint
event_typesstring[]✅não vazio; cada item é um tipo de evento do catálogo ou *Eventos assinados (ex.: ["appointment.queued", "appointment.canceled"]) ou ["*"] para todos
filtersobject❌hoje só procedure_typesRestringe os eventos enviados. procedure_types: lista de tipos de procedimento em maiúsculas; só vale para eventos appointment.*

Requisição​

curl -X 'POST' \
'https://api-dev.imagemais.com.br/api/webhooks/endpoints' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}' \
-H 'Content-Type: application/json' \
-d '{
"url": "https://consumidor.exemplo/webhooks/pepia/clinica-x",
"description": "Integração com o sistema da clínica",
"event_types": [
"appointment.queued",
"appointment.canceled"
],
"filters": {
"procedure_types": [
"IMAGEM"
]
}
}'

Respostas​

201 Sucesso​

{
"id": 3,
"url": "https://consumidor.exemplo/webhooks/pepia/clinica-x",
"description": "Integração com o sistema da clínica",
"event_types": [
"appointment.queued",
"appointment.canceled"
],
"filters": {
"procedure_types": [
"IMAGEM"
]
},
"enabled": true,
"disabled_reason": null,
"disabled_at": null,
"failing_since": null,
"created_by": {
"type": "user",
"id": 345,
"name": "Nome Exemplo"
},
"created_at": "2026-10-06T14:32:10.123Z",
"updated_at": "2026-10-06T14:32:10.123Z",
"secret": "whsec_Zm9vYmFyYmF6cXV4Zm9vYmFyYmF6cXV4Zm9vYmFyYmE="
}

400 Requisição inválida​

Retornado quando o corpo ou a query não passam na validação. A lista message traz um item por regra violada, por exemplo:

{
"message": [
"url must be a URL address",
"event_types should not be empty"
],
"error": "Bad Request",
"statusCode": 400
}

Outras mensagens possíveis: each value in event_types must be one of the following values: … (tipo fora do catálogo).

403 Sem permissão​

{
"message": "Permissões insuficientes",
"error": "Forbidden",
"statusCode": 403
}

422 Regra de negócio​

Mensagens possíveis:

  • Limite de 10 endpoints por conta atingido
  • A URL do webhook precisa usar https (em produção)
  • Não foi possível resolver o host {host}
  • A URL do webhook aponta para uma rede interna
  • Filtro desconhecido: {nome}
  • Valores aceitos em procedure_types: {lista}
  • O filtro procedure_types só vale para eventos appointment.*
{
"message": "Limite de 10 endpoints por conta atingido",
"error": "Unprocessable Entity",
"statusCode": 422
}