Criar webhook via API
Registra um endpoint para receber eventos da loja de forma programática — alternativa ao cadastro pelo painel.
POST
https://api.aproveicheckout.com.br/v1/webhooks
Autenticação: token Bearer com a ability
webhooks:create + headers X-Store-Slug e Content-Type: application/json.
Ver autenticação →
Limite de 60 requisições/min —
ver erros e limites.
Body
| Campo | Tipo | Descrição |
|---|---|---|
url Obrigatório |
string | URL do seu endpoint. Em produção, deve usar HTTPS |
events Obrigatório |
array | Eventos a receber — somente os listados no Guia de Webhooks |
Request
{
"url": "https://cliente.com/webhook",
"events": ["order.paid", "payment.pix.created"]
}Resposta
Response 201
{
"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-01T12:00:00-03:00",
"secret_preview": "****a1b2"
},
"secret": "apv_whsec_..."
}
Importante: o secret é gerado pelo backend e
exibido uma única vez, nesta resposta — guarde-o com segurança. Ele assina todas as entregas via
X-Aprovei-Signature (como
validar). Cada loja pode ter no máximo 10 webhooks — acima disso a API retorna
422 WEBHOOK_LIMIT_EXCEEDED.