Documentação › Webhooks › Editar via API

Editar webhook via API

Atualiza URL, eventos ou status de um webhook da loja. O secret atual é preservado.

PATCH https://api.aproveicheckout.com.br/v1/webhooks/{id}

Autenticação: token Bearer com a ability explícita webhooks:update + headers X-Store-Slug e Content-Type: application/json. Tokens com * não autorizam esta operação. Limite de 60 requisições/min.

Body

Envie ao menos um campo.

Request 
{
  "url": "https://cliente.com/webhook",
  "events": ["order.paid", "payment.pix.created"],
  "is_active": true
}

Resposta

Response 200 
{
  "webhook": {
    "id": 12,
    "url": "https://cliente.com/webhook",
    "events": ["order.paid", "payment.pix.created"],
    "is_active": true,
    "created_at": "2026-07-01T12:00:00-03:00",
    "updated_at": "2026-07-08T12:00:00-03:00",
    "secret_preview": "****a1b2"
  }
}

A API retorna 404 WEBHOOK_NOT_FOUND para webhook inexistente ou de outra loja. URL insegura, evento inválido, lista vazia de eventos ou body vazio retornam 422 VALIDATION_ERROR.