Skip to main content

POST Rotacionar Segredo

Gera um novo segredo de assinatura e o devolve uma única vez. O segredo anterior continua assinando por 24 horas: até previous_secret_expires_at, cada entrega leva as duas assinaturas no header webhook-signature, o que permite trocar o segredo no consumidor sem perder eventos.

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​

POST https://api-dev.imagemais.com.br/api/webhooks/endpoints/{id}/rotate-secret

Parâmetros de Rota​

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

Requisição​

curl -X 'POST' \
'https://api-dev.imagemais.com.br/api/webhooks/endpoints/1/rotate-secret' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}'

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": 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_bm92b3NlZ3JlZG9ub3Zvc2VncmVkb25vdm9zZWdyZWQ=",
"previous_secret_expires_at": "2026-10-07T18:00:00.000Z"
}

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
}