Rotacionar o secret

POST

/v1/endpoints/{id}/rotate-secret

Gera um secret novo e mantém o anterior válido por 24 horas. Durante essa janela, toda entrega vai assinada com os dois, lado a lado no mesmo header Webhook-Signature. É o tempo de trocar o valor do lado de quem recebe sem perder nenhuma entrega.

previousSecretExpiresAt diz quando o anterior para de assinar. O secret novo aparece só nesta resposta.

Autorização

• Bearer

Parâmetros

Parâmetros de caminho

id

obrigatório

string

Respostas

200

Sucesso.

Tipo de mídiaapplication/json

object

id

obrigatório

string

secret

obrigatório

string

previousSecretExpiresAt

obrigatório

string formato: date-time

Exemplo^gerado

{
  "id": "example",
  "secret": "example",
  "previousSecretExpiresAt": "2026-04-15T12:00:00Z"
}

401

Chave de API ausente, inválida ou revogada.

404

O endpoint não existe, ou não é deste ambiente.

429

Limite de requisições por segundo do plano, somado entre todas as chaves da organização.

Headers

Retry-After

integer

Segundos até a próxima janela.