Skip to main content
PATCH
/
webhooks
/
update
/
{id}
curl -X PATCH 'https://api.goatpay.com.br/v1/webhooks/update/clx_webhook_endpoint' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{ "status": "DISABLED", "events": ["payment.paid"] }'
{
  "success": true,
  "message": "Webhook atualizado com sucesso",
  "data": {
    "item": {
      "id": "clx_webhook_endpoint",
      "url": "https://api.suaempresa.com/webhooks/goatpay",
      "description": "ERP produção",
      "events": ["payment.paid"],
      "status": "Pausado",
      "createdAt": "2026-06-01T14:30:00.000Z"
    }
  },
  "requestId": "req_abc123"
}
curl -X PATCH 'https://api.goatpay.com.br/v1/webhooks/update/clx_webhook_endpoint' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{ "status": "DISABLED", "events": ["payment.paid"] }'
{
  "success": true,
  "message": "Webhook atualizado com sucesso",
  "data": {
    "item": {
      "id": "clx_webhook_endpoint",
      "url": "https://api.suaempresa.com/webhooks/goatpay",
      "description": "ERP produção",
      "events": ["payment.paid"],
      "status": "Pausado",
      "createdAt": "2026-06-01T14:30:00.000Z"
    }
  },
  "requestId": "req_abc123"
}

Corpo da requisição

url
string
Nova URL HTTPS.
description
string
Nova descrição.
events
array
Nova lista de eventos.
status
string
ACTIVE ou DISABLED.

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.)

Body

application/json
url
string<uri>
description
string
events
string[]
status
enum<string>
Available options:
ACTIVE,
DISABLED

Response

200 - application/json

Webhook consultado, atualizado ou removido.

success
boolean
required
message
string
required
data
object
required
requestId
string