Atualizar Webhook

Atualiza a URL de destino, a lista de eventos assinados ou o status de ativação do webhook cadastrado.

PUThttps://api.nfer.me/v1/webhooks/:id

Headers da Requisição

X-API-Keystringobrigatório

Chave de API.

Parâmetros de Rota (Path Parameters)

idstringobrigatório

ID do webhook.

Exemplo: wh_778899

Corpo da Requisição (JSON Body)

urlstring<url>opcional

Nova URL de callback HTTPS.

Exemplo: https://meu-erp.com.br/v2/webhook

activebooleanopcionalpadrão: true

Pausa ou reativa os envios de notificações (true para ativo, false para pausado).

eventsarray<string>opcional

Nova lista de eventos assinados.

descriptionstringopcional

Nova descrição do webhook.

secretstringopcional

Novo segredo HMAC customizado.

Atualizar Webhook

curl --request PUT \
  --url https://api.nfer.me/v1/webhooks/:id \
  --header 'X-API-Key: <sua_chave_api>' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "https://meu-erp.com.br/v2/webhook",
  "active": "true",
  "events": [],
  "description": "<description>",
  "secret": "<secret>"
}'

{
  "id": "wh_778899",
  "url": "https://meu-erp.com.br/v2/webhook",
  "active": true,
  "events": [
    "nfe.autorizada",
    "nfe.cancelada"
  ],
  "updated_at": "2026-09-20T21:00:00.000Z"
}