Skip to main content
PUT
Esta rota altera um endpoint de webhook já cadastrado. Use-a para trocar a URL de recebimento (por exemplo, numa migração de servidor), ajustar a lista de eventos ou ligar e desligar o recebimento dos eventos das subcontas.

Quando usar

Antes de chamar

  • Use a chave secreta (sk_) em Basic (Credenciais e ambientes). A chave age com as permissões do usuário que a gerou: um perfil sem permissão de webhooks recebe 403 Acesso negado.
  • Tenha o id do endpoint, obtido em GET /v1/webhook-endpoints.
  • O corpo usa snake_case, como na criação.

Parâmetros de caminho

string
required
Id do endpoint, o campo id da listagem. Ex.: 2wHn5Qe8rT1yU4iO7pA3sD6fG9k.

Corpo da requisição

Todos os campos são opcionais. Envie os que você quer alterar.
string
Novo endereço http ou https público. Endereços internos e reservados são recusados. Ex.: https://api.meusite.com.br/webhooks/finvia.
string[]
Lista de eventos que o endpoint recebe. Lista vazia ([]) recebe todos. Os nomes possíveis estão em Criar endpoint. Incluir charge.updated não tem efeito: ele só vai ao postbackUrl da cobrança.
boolean
Só para conta master com Connect habilitado. Com true, o endpoint recebe também os eventos das subcontas; com false, deixa de receber.

Respostas

A resposta de sucesso é 200 sem corpo. Para conferir o resultado, use GET /v1/webhook-endpoints. Mensagens literais da API (trate o erro pelo código HTTP, não pelo texto):

Erros comuns

Veja também

Listar endpoints

Obtenha o id e confira o resultado.

Excluir endpoint

Pare de enviar eventos para uma URL.

Criar endpoint

Nomes de eventos e regras do cadastro.

Webhooks: visão geral

Quem recebe cada evento e em que formato.