Skip to main content
DELETE
Remover webhook
DELETE /webhooks/:id Faz parte do recurso Webhooks — o cadastro e o catálogo de eventos estão lá. Remove o webhook e devolve 200 com o registro removido. A partir daí nenhum evento é enviado para aquele endereço.
deletedAt preenchido é a confirmação da remoção. Ele só aparece nesta resposta: as demais leituras nunca devolvem registro removido — o webhook some da listagem e passa a responder 404 na busca por ID.
Não há como desfazer, e o secret vai junto. Para voltar a receber é preciso criar outro webhook, que nasce com um segredo novo — o seu receptor precisa passar a verificar a assinatura com ele.Se a intenção é só parar por um tempo, desative em vez de remover: o cadastro e o segredo permanecem.
As entregas já registradas continuam consultáveis em Listar deliveries — o histórico não é apagado com o cadastro. O que não dá mais é reprocessá-las: sem o webhook, o reenvio responde 404 WEBHOOK_NOT_FOUND.

Exemplo

Resposta 200

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Headers

Idempotency-Key
string

Chave única para garantir idempotência da requisição

Path Parameters

id
string
required

ID do webhook

Response

Webhook removido

id
string
required

Identificador único do registro.

name
string
required

Nome do registro.

url
string<uri>
required

URL de destino do webhook ou link de download do arquivo.

events
string[]
required

Tipos de evento assinados pelo webhook.

isActive
boolean
required

Indica se o registro está ativo.

hasSecret
boolean
required
secretHint
string | null
required
autoDisabledAt
string<date-time> | null
required
createdAt
string<date-time>
required

Data e hora de criação do registro (ISO 8601).

updatedAt
string<date-time>
required

Data e hora da última atualização do registro (ISO 8601).

deletedAt
string<date-time> | null
required

Data e hora de exclusão (soft delete); nulo se ativo.