Documentação da API v1 · Conheça a Naut
v1

Girar o segredo de um endpoint

Emite um segredo novo para o endpoint e invalida o anterior. Troque-o no seu verificador antes da próxima entrega.

POSThttps://api.navenaut.com/webhooks-out/endpoints/{endpointId}/rotate-secret

Autenticação

A sessão do painel autentica esta rota, e ela é lida de forma autoritativa: não há parâmetro em que o chamador aponte para outra conta.

Esta rota não exige escopo nomeado — o que não quer dizer que ela seja aberta: sem a credencial acima ela recusa.

Exige sessão de vendedor. Todo endpoint lido ou escrito é escopado pela sessão: o identificador na URL nunca alcança o endpoint de outro vendedor.

Parâmetros

Caminho

NomeTipoDescrição
endpointIdobrigatóriotextoO identificador do endpoint, como ele aparece na listagem.

Respostas

200 · sucesso

{
  "id": "0f2a4e6c-91c4-4e1b-9a3d-5b7c2e8f4a06",
  "secret": "valor-de-exemplo-nao-use"
}

404 · não encontrado

O endpoint não existe, ou não é seu.

Erros desta rota

StatusCódigoQuandoO que fazer
404WEBHOOK_ENDPOINT_NOT_FOUNDO identificador não existe, ou o endpoint é de outra conta. As duas causas respondem igual de propósito: distinguir revelaria a existência de endpoint alheio.Confira o identificador na listagem de endpoints. Repetir não muda o resultado, e o segredo vigente continua o mesmo: nenhum verificador precisa ser trocado.

Os códigos são estáveis e fazem parte do contrato. A lista completa, com todos os vocabulários, está na tabela de erros.