Skip to main content
POST
/
webhooks
Criar webhook endpoint
curl --request POST \
  --url https://api.pagozz.com/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'Pagozz-Token: <api-key>' \
  --data '
{
  "url": "https://meusite.com/webhooks",
  "events": [
    "payment.succeeded",
    "payment.failed"
  ]
}
'
{
  "data": {
    "id": "f1e2d3c4-b5a6-7890-cdef-123456789012",
    "url": "https://meusite.com/webhooks",
    "events": [
      "payment.succeeded",
      "payment.failed"
    ],
    "status": "active",
    "environment": "live",
    "created_at": "2026-02-28T10:00:00.000Z",
    "updated_at": "2026-02-28T10:00:00.000Z",
    "secret": "whsec_a1b2c3d4e5f6..."
  }
}

Authorizations

​
Pagozz-Token
string
header
required

Chave de API no formato pgz_test_* (test mode) ou pgz_live_* (live mode). O ambiente é determinado automaticamente pelo prefixo da chave.

Body

application/json
​
url
string<uri>
required

Obrigatório. URL HTTPS do endpoint.

​
events
enum<string>[]
required

Obrigatório. Lista de eventos para receber (mínimo 1).

Minimum array length: 1
Available options:
payment.created,
payment.succeeded,
payment.failed,
payment.expired,
link.created,
link.updated,
link.deactivated,
payout.created,
payout.succeeded,
payout.failed

Response

Webhook endpoint criado com sucesso.

​
data
object

Representa um webhook endpoint configurado para receber notificações de eventos.