Skip to main content
POST

Corpo da requisição

string
required
URL HTTPS pública.
string
required
Nome do endpoint.
array
required
Lista de eventos. Veja o guia Webhooks.
A resposta inclui secret whsec_… exibido uma única vez.

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