Pular para o conteúdo principal
POST
https://api.owem.com.br
/
v4
/
i
/
webhooks
/
config
Criar Webhook
curl --request POST \
  --url https://api.owem.com.br/v4/i/webhooks/config \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "event": [
    {}
  ],
  "targetUrl": "<string>",
  "authHeader": "<string>"
}
'
{
  "requestId": "a111b222-c333-4d44-8e55-f66677788899",
  "success": true,
  "size": 1,
  "data": {
    "configId": "wc_bd121426-4da1-4de4-b420-1b063aef81ee",
    "userId": "usr_abcdef12",
    "event": ["*"],
    "targetUrl": "https://hooks.cliente.com/owem",
    "authHeader": "Bearer whsec_abc123example",
    "isEnabled": true,
    "createdAt": 1766523042000,
    "updatedAt": 1766523042000,
    "deletedAt": null
  }
}

​
Finalidade

Cria uma configuração de webhook para receber eventos da Owem no endpoint do cliente.

​
Autenticação

​
Authorization
string
obrigatório
Basic Auth obrigatório no formato: Basic {Base64(API_KEY:API_SECRET)}

​
Requisitos de Entrega

  • IPs de origem Owem: 34.134.50.53, 35.238.101.57
  • Seu endpoint deve responder 2xx em até 3s (ack)
  • Reentrega com backoff exponencial em falha
  • Múltiplas falhas podem desativar o webhook

​
Request Body

​
event
array
obrigatório
Eventos de interesse. Use ["*"] para todos os eventos, ou liste específicos.
​
targetUrl
string
obrigatório
URL HTTPS pública para recebimento dos webhooks. Deve aceitar POST e retornar 2xx em ≤ 3s.
​
authHeader
string
Valor a ser enviado em Authorization em todas as chamadas de webhook.

​
Eventos Suportados

EventoDescrição
pix_in:qrcode_paidPagamento via QR Code
pix_in:creditedCrédito via chave PIX
pix_in:refunded_processingEstorno de PIX IN iniciado
pix_out:processingPIX OUT registrado
pix_out:refunded_processingDevolução de PIX OUT
med:receivedMED recebido
*Todos os eventos

​
Resposta

​
requestId
string
UUID para rastreio
​
success
boolean
Status da operação
​
size
number
Quantidade de itens retornados
​
data
object
{
  "requestId": "a111b222-c333-4d44-8e55-f66677788899",
  "success": true,
  "size": 1,
  "data": {
    "configId": "wc_bd121426-4da1-4de4-b420-1b063aef81ee",
    "userId": "usr_abcdef12",
    "event": ["*"],
    "targetUrl": "https://hooks.cliente.com/owem",
    "authHeader": "Bearer whsec_abc123example",
    "isEnabled": true,
    "createdAt": 1766523042000,
    "updatedAt": 1766523042000,
    "deletedAt": null
  }
}

​
Códigos de Status

HTTPDescrição
201Configuração criada
400Payload inválido
401Credenciais inválidas
403IP não allowlisted
409Conflito (config duplicada)
429Rate limit excedido
500Erro interno

​
Exemplo de Request

{
  "event": ["*"],
  "targetUrl": "https://hooks.cliente.com/owem",
  "authHeader": "Bearer whsec_abc123example"
}
Use URL dedicada para webhooks, com observabilidade (logs/trace).
Proteja o authHeader como segredo e rotacione periodicamente.