Skip to main content
GET
/
webhooks
/
list
curl -X GET 'https://api.goatpay.com.br/v1/webhooks/list' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "Webhooks listados com sucesso",
  "data": {
    "items": [
      {
        "id": "clx_webhook_endpoint",
        "url": "https://api.suaempresa.com/webhooks/goatpay",
        "description": "ERP produção",
        "events": ["payment.paid", "transfer.completed"],
        "status": "Ativo",
        "createdAt": "2026-06-01T14:30:00.000Z"
      }
    ]
  },
  "requestId": "req_abc123"
}

curl -X GET 'https://api.goatpay.com.br/v1/webhooks/list' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "Webhooks listados com sucesso",
  "data": {
    "items": [
      {
        "id": "clx_webhook_endpoint",
        "url": "https://api.suaempresa.com/webhooks/goatpay",
        "description": "ERP produção",
        "events": ["payment.paid", "transfer.completed"],
        "status": "Ativo",
        "createdAt": "2026-06-01T14:30:00.000Z"
      }
    ]
  },
  "requestId": "req_abc123"
}
O histórico de entregas HTTP fica no painel da conta. Esta rota retorna apenas os endpoints configurados.

Authorizations

​
X-API-Key
string
header
required

Chave gp_live_... criada em Integrações → Chaves de API no dashboard.

Response

200 - application/json

Lista de endpoints de webhook (sem histórico de entregas).

​
success
boolean
required
​
message
string
required
​
data
object
required
​
requestId
string