Versionamento
Esta referência descreve a versão 2026-10-12. Não há segmento de versão na URL.
Por que não existe /v1
Versão no caminho é a promessa de manter dois servidores no ar. Preferimos prometer algo que dá para cumprir: só mudanças aditivas, mais um caminho de depreciação escrito para o que precisar sair.
O que pode mudar sem aviso
- Endpoints novos, campos opcionais novos na requisição, campos novos na resposta.
- Valores novos num enum que você só lê (nunca num que você envia).
- Tipos de evento novos no catálogo e cabeçalhos novos nas entregas de webhook.
O que conta como quebra, e como você fica sabendo
Remover campo ou endpoint, renomear qualquer coisa, apertar validação, ou mudar código de status. Essas vêm com: aviso no e-mail do proprietário do workspace, cabeçalhos Deprecation e Sunset nas respostas afetadas, e pelo menos 90 dias até a mudança entrar.
O número da versão é uma data
2026-10-12 é o dia em que este documento foi gerado do servidor. Ela responde a única pergunta que uma data precisa responder — isto é mais novo do que o que li da última vez? — e ninguém precisa lembrar de incrementar nada.