Skip to main content
PATCH
/
webhooks
/
{id}
Atualizar webhook endpoint
curl --request PATCH \
  --url https://api.pagozz.com/v1/webhooks/{id} \
  --header 'Content-Type: application/json' \
  --header 'Pagozz-Token: <api-key>' \
  --data '
{
  "events": [
    "payment.succeeded",
    "payment.failed",
    "payment.expired"
  ]
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "url": "<string>",
    "events": [
      "payment.created"
    ],
    "status": "active",
    "environment": "test",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "secret": "<string>"
  }
}

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.

Path Parameters

​
id
string<uuid>
required

ID do webhook endpoint.

Body

application/json

Campos opcionais para atualizar o webhook endpoint.

​
url
string<uri>

Opcional. Nova URL HTTPS.

​
events
enum<string>[]

Opcional. Nova lista de eventos.

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

​
data
object

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