Skip to main content

PATCH Atualizar Endpoint de Webhook

Altera URL, descrição, eventos, filtros ou o estado (enabled) de um endpoint. Todos os campos são opcionais.

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.


Endpoint​

PATCH https://api-dev.imagemais.com.br/api/webhooks/endpoints/{id}

Parâmetros de Rota​

NomeTipoObrigatórioDescrição
idnumber✅ID do endpoint de webhook

Corpo da Requisição​

CampoTipoObrigatórioValores válidosDescrição
urlstring❌URL http/https com protocolo; até 2048 caracteresNova URL
descriptionstring❌até 255 caracteresNova descrição
event_typesstring[]❌não vazio; tipos do catálogo ou *Nova lista de eventos assinados
filtersobject | null❌hoje só procedure_typesNovos filtros; null remove os filtros
enabledboolean❌true ou falsefalse desativa (disabled_reason: MANUAL); true reativa e zera failing_since

Requisição​

curl -X 'PATCH' \
'https://api-dev.imagemais.com.br/api/webhooks/endpoints/1' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}' \
-H 'Content-Type: application/json' \
-d '{
"enabled": false
}'

Respostas​

200 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": false,
"disabled_reason": "MANUAL",
"disabled_at": "2026-10-06T18:00:00.000Z",
"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"
}

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": [
"enabled must be a boolean value"
],
"error": "Bad Request",
"statusCode": 400
}

403 Sem permissão​

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

404 Não encontrado​

{
"message": "Endpoint de webhook não encontrado",
"error": "Not Found",
"statusCode": 404
}

422 Regra de negócio​

Mesmas regras de Criar Endpoint de Webhook: URL para rede interna, https em produção, host não resolvido e filtros inválidos. Os filtros são conferidos contra os event_types resultantes (os novos ou, se não vieram, os atuais).

{
"message": "O filtro procedure_types só vale para eventos appointment.*",
"error": "Unprocessable Entity",
"statusCode": 422
}