Skip to main content
POST
/
webhooks
/
create
curl -X POST 'https://api.goatpay.com.br/v1/webhooks/create' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{ "url": "https://api.suaempresa.com/webhooks/goatpay", "description": "ERP produção", "events": ["payment.paid", "transfer.completed"] }'
{
  "success": true,
  "message": "Webhook criado 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"
    },
    "secret": "whsec_0123456789abcdef0123456789abcdef0123456789abcdef"
  },
  "requestId": "req_abc123"
}
curl -X POST 'https://api.goatpay.com.br/v1/webhooks/create' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{ "url": "https://api.suaempresa.com/webhooks/goatpay", "description": "ERP produção", "events": ["payment.paid", "transfer.completed"] }'
{
  "success": true,
  "message": "Webhook criado 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"
    },
    "secret": "whsec_0123456789abcdef0123456789abcdef0123456789abcdef"
  },
  "requestId": "req_abc123"
}

Corpo da requisição

url
string
required
URL HTTPS pública.
description
string
required
Nome legível do endpoint.
events
array
required
Lista de eventos. Veja Guia de webhooks.
Guarde data.secret (whsec_...) em variável de ambiente. Ele não é retornado em consultas posteriores.

Authorizations

X-API-Key
string
header
required

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

Body

application/json
url
string<uri>
required

HTTPS obrigatório.

description
string
required
Maximum string length: 120
events
enum<string>[]
required
Required array length: 1 - 80 elements
Available options:
payment.created,
payment.paid,
payment.failed,
payment.refunded,
payment.pix.expired,
payment.crypto.created,
payment.crypto.paid,
payment.crypto.failed,
payment.crypto.expired,
transfer.created,
transfer.crypto.completed,
transfer.crypto.failed,
transfer.completed,
transfer.failed,
med.created,
med.updated,
med.evidence_sent,
webhook.test

Response

Webhook cadastrado (secret exibido uma vez).

success
boolean
required
message
string
required
data
object
required
requestId
string