POSTWebhooks & API Keys

Criar webhook (outbound)

Cadastra uma URL de destino para eventos assinados. O secret é retornado em claro UMA vez (guarde-o).

POST/webhook-subscriptions
AutenticaçãoPainel admin

Cookie de sessão do painel (ecom_token) + permissão RBAC.

Corpo da requisição

  • urlstringobrigatório

    URL de destino (HTTPS).

  • eventosarrayobrigatório

    Eventos assinados (ex.: order.paid).

Cabeçalhos

  • Cookiestringobrigatório

    Cookie de sessão do painel: ecom_token=<jwt> (obtido em POST /auth/login).

Requisição

curl -X POST "https://api.ecomplataforma.com.br/webhook-subscriptions" \
  -b cookies.txt -H "Content-Type: application/json" \
  -d '{"url":"https://app.exemplo.com/webhook","eventos":["order.paid"]}'

Resposta201

200 OK
{ "success": true, "data": { "id": "wh_2", "secret": "whsec_..." } }

Respostas de erro

401Não autenticado
401 Não autenticado
{
  "success": false,
  "error": "Sessão ausente ou expirada."
}
403Sem permissão
403 Sem permissão
{
  "success": false,
  "error": "Você não tem permissão para acessar este recurso."
}
422Falha de validação
422 Falha de validação
{
  "success": false,
  "error": "O campo 'email' é obrigatório."
}