Remover um webhook

Endpoint responsável por remover um webhook configurado na conta.

A requisição utiliza o identificador do webhook (id) no endpoint:

DELETE /v3/webhooks/{id}

Quando um webhook é removido:

  • novos eventos deixam de ser enviados para a URL configurada
  • o Asaas interrompe imediatamente as tentativas de entrega relacionadas àquele webhook
  • a integração deixa de receber notificações automáticas vinculadas à configuração removida

Quando utilizar este endpoint

Esse endpoint deve ser utilizado quando for necessário descontinuar o recebimento de notificações automáticas, por exemplo:

  • desativação de uma integração
  • troca da URL de recebimento de eventos
  • remoção de ambientes antigos ou URLs inválidas
  • encerramento de uma aplicação integrada
  • reestruturação da arquitetura de webhooks
❗️

Atenção

Esta ação não pode ser desfeita.

  • Após a remoção do webhook, será necessário criar uma nova configuração caso deseje voltar a receber eventos automaticamente.

Impacto da remoção

Após a exclusão:

  • eventos futuros não serão mais enviados para o webhook removido
  • tentativas automáticas de retry deixam de ocorrer
  • o identificador removido não poderá ser reutilizado

Caso sua aplicação ainda dependa do recebimento de eventos, recomenda-se validar previamente se existe outro webhook ativo configurado corretamente.

Parâmetros

  • id
  • string • obrigatório - Identificador único do webhook configurado no Asaas.
Path Params
string
required
Responses

404

Not found

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json