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

{
  "success": true,
  "message": "Webhook consultado com sucesso",
  "data": {
    "item": {
      "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/get/clx_webhook_endpoint' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "Webhook consultado com sucesso",
  "data": {
    "item": {
      "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"
}

​
Parâmetros

​
id
string
required
ID do endpoint.

Authorizations

​
X-API-Key
string
header
required

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

Path Parameters

​
id
string
required

ID do recurso (transação, cobrança, webhook, etc.)

Response

Webhook consultado, atualizado ou removido.

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