Documentação › Webhooks › Listar via API

Listar webhooks via API

Retorna os webhooks cadastrados da loja. O secret nunca é retornado na listagem — apenas o secret_preview.

GET https://api.aproveicheckout.com.br/v1/webhooks

Autenticação: token Bearer com a ability webhooks:read + header X-Store-Slug. Ver autenticação → Limite de 300 requisições/min — ver erros e limites.

Exemplo de Requisição

cURL
curl --location 'https://api.aproveicheckout.com.br/v1/webhooks' \
--header 'Authorization: Bearer SEU_TOKEN' \
--header 'X-Store-Slug: SLUG_DA_LOJA'

Resposta

Response 200
{
  "webhooks": [
    {
      "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-01T12:00:00-03:00",
      "secret_preview": "****a1b2"
    }
  ]
}

Relacionados