Cadastrar Webhook

Endpoints para criar, listar e remover webhooks de notificacao.

---

Criar Webhook

POST /api/v2/external/webhooks

Headers

Header	Tipo	Obrigatorio	Descricao
Authorization	String	Sim	Bearer {access_token}
Content-Type	String	Sim	application/json
hmac	String	Sim	Assinatura HMAC-SHA512 do body (saiba mais)

Request Body

Campo	Tipo	Obrigatorio	Descricao
url	String	Sim	URL HTTPS para receber notificacoes
events	Array	Nao	Lista de eventos para assinar. Se omitido, assina todos.

Eventos disponiveis: pix.received, pix.completed, pix.failed, pix.refund, pix.med

Exemplo

BODY='{"url":"https://seusite.com.br/webhook","events":["pix.received","pix.completed"]}'
HMAC=$(echo -n "$BODY" | openssl dgst -sha512 -hmac "$CLIENT_SECRET" | awk '{print $2}')

curl -X POST https://api.owem.com.br/api/v2/external/webhooks \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -H "hmac: $HMAC" \
  -d "$BODY"

Resposta de Sucesso (201)

{
  "worked": true,
  "webhook": {
    "id": "wh_a1b2c3d4e5f6",
    "url": "https://seusite.com.br/webhook",
    "events": ["pix.received", "pix.completed"],
    "status": "active",
    "created_at": "2026-03-07T15:30:00Z"
  }
}

Resposta de Erro (422)

{
  "worked": false,
  "detail": "URL deve utilizar HTTPS"
}

Apenas HTTPS

A URL do webhook deve obrigatoriamente utilizar HTTPS. URLs com HTTP serao rejeitadas.

---

Listar Webhooks

GET /api/v2/external/webhooks

Headers

Header	Tipo	Obrigatorio	Descricao
Authorization	String	Sim	Bearer {access_token}

Exemplo

curl -X GET https://api.owem.com.br/api/v2/external/webhooks \
  -H "Authorization: Bearer $TOKEN"

Resposta de Sucesso (200)

{
  "worked": true,
  "webhooks": [
    {
      "id": "wh_a1b2c3d4e5f6",
      "url": "https://seusite.com.br/webhook",
      "events": ["pix.received", "pix.completed"],
      "status": "active",
      "created_at": "2026-03-07T15:30:00Z"
    }
  ]
}

---

Remover Webhook

DELETE /api/v2/external/webhooks/:id

Headers

Header	Tipo	Obrigatorio	Descricao
Authorization	String	Sim	Bearer {access_token}

Path Parameters

Parametro	Tipo	Obrigatorio	Descricao
id	String	Sim	ID do webhook

Exemplo

curl -X DELETE https://api.owem.com.br/api/v2/external/webhooks/wh_a1b2c3d4e5f6 \
  -H "Authorization: Bearer $TOKEN"

Resposta de Sucesso (200)

{
  "worked": true
}

Resposta de Erro (404)

{
  "worked": false,
  "detail": "Webhook nao encontrado"
}