Listar webhooks

Retorna a lista de webhooks configurados para sua conta (URL e eventos associados).

Overview

Use para listar as URLs de notificação e os eventos que cada uma recebe. Consulte a seção Eventos disponíveis para os tipos de evento.

Endpoint

GETGET /webhooks

Base URL:https://api.onnixpay.com/api/v1/sdk

Headers

Header	Obrigatório	Descrição
X-API-Key	Sim	Sua API Key.

Exemplo cURL

cURL

curl -X GET "https://api.onnixpay.com/api/v1/sdk/webhooks" \
  -H "X-API-Key: ox_sua_chave_aqui"

Response — Sucesso (200)

JSON

{
  "data": [
    {
      "id": "wh_001",
      "url": "https://sua-api.com/webhooks/onnixpay",
      "events": ["transaction.completed", "pix.received"],
      "active": true,
      "createdAt": "2025-02-09T12:00:00.000Z"
    }
  ]
}

Campos da resposta

Campo	Tipo	Descrição
data	array	Lista de webhooks configurados.
id	string	ID do webhook (em cada item de data).
url	string	URL que recebe as notificações POST (em cada item).
events	array	Tipos de evento inscritos (ex.: transaction.completed, pix.received).
active	boolean	Se o webhook está ativo (em cada item).
createdAt	string	Data de criação em ISO 8601 (em cada item).

Status codes e erros comuns

Status	Código	Mensagem
401	INVALID_API_KEY	Chave de API inválida ou ausente.

Headers

X-API-Key: ox_sua_chave_aqui

cURL

curl -X GET "https://api.onnixpay.com/api/v1/sdk/webhooks" \
  -H "X-API-Key: ox_sua_chave_aqui"

Response (200)

{
  "data": [
    {
      "id": "wh_001",
      "url": "https://sua-api.com/webhooks/onnixpay",
      "events": ["transaction.completed", "pix.received"],
      "active": true,
      "createdAt": "2025-02-09T12:00:00.000Z"
    }
  ]
}